diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json
index 4f55c4474..1b9e367b9 100644
--- a/descriptions/api.github.com/api.github.com.2022-11-28.json
+++ b/descriptions/api.github.com/api.github.com.2022-11-28.json
@@ -29077,313 +29077,6 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
- "get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- },
- {
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "post": {
- "summary": "Create a discussion",
- "description": "Creates 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\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- }
- ],
- "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": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
"/orgs/{org}/teams/{team_slug}/invitations": {
"get": {
"summary": "List pending team invitations",
@@ -65036,304 +64729,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "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": [
- {
- "$ref": "#/components/parameters/team-id"
- }
- ],
- "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": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "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": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
@@ -120095,104 +119490,6 @@
"organization"
]
},
- "team-discussion": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/components/schemas/nullable-simple-user"
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "
Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "$ref": "#/components/schemas/reaction-rollup"
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
"team-membership": {
"title": "Team Membership",
"description": "Team Membership",
@@ -289922,158 +289219,6 @@
}
}
},
- "team-discussion-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": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- },
- "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",
- "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",
- "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-membership-response-if-user-is-a-team-maintainer": {
"summary": "Response if user is a team maintainer",
"value": {
@@ -311099,15 +310244,6 @@
"type": "string"
}
},
- "discussion-number": {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
"security-product": {
"name": "security_product",
"in": "path",
diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
index 9b56c35ba..82a860095 100644
--- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml
+++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
@@ -21036,231 +21036,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#list-discussions
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#create-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- 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:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#get-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#update-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#delete-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/invitations":
get:
summary: List pending team invitations
@@ -47223,235 +46998,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- 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]
- > **Endpoint closing down notice:** 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.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- 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:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- 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]
- > **Endpoint closing down notice:** 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.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth 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:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -88142,89 +87688,6 @@ components:
- members_count
- repos_count
- organization
- team-discussion:
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form conversation
- within a team.
- type: object
- properties:
- author:
- "$ref": "#/components/schemas/nullable-simple-user"
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a team
"
- body_version:
- description: The current version of the body content. If provided, this
- update operation will be rejected if the given version does not match
- the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted to team
- members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions:
- "$ref": "#/components/schemas/reaction-rollup"
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
team-membership:
title: Team Membership
description: Team Membership
@@ -217766,144 +217229,6 @@ components:
created_at: '2008-01-14T04:33:35Z'
updated_at: '2017-08-17T12:37:15Z'
type: Organization
- team-discussion-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: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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
- 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-membership-response-if-user-is-a-team-maintainer:
summary: Response if user is a team maintainer
value:
@@ -236088,13 +235413,6 @@ components:
required: true
schema:
type: string
- discussion-number:
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
security-product:
name: security_product
in: path
diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
index 4f55c4474..1b9e367b9 100644
--- a/descriptions/api.github.com/api.github.com.json
+++ b/descriptions/api.github.com/api.github.com.json
@@ -29077,313 +29077,6 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
- "get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- },
- {
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "post": {
- "summary": "Create a discussion",
- "description": "Creates 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\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- }
- ],
- "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": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
"/orgs/{org}/teams/{team_slug}/invitations": {
"get": {
"summary": "List pending team invitations",
@@ -65036,304 +64729,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "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": [
- {
- "$ref": "#/components/parameters/team-id"
- }
- ],
- "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": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "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": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
@@ -120095,104 +119490,6 @@
"organization"
]
},
- "team-discussion": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/components/schemas/nullable-simple-user"
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "$ref": "#/components/schemas/reaction-rollup"
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
"team-membership": {
"title": "Team Membership",
"description": "Team Membership",
@@ -289922,158 +289219,6 @@
}
}
},
- "team-discussion-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": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- },
- "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",
- "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",
- "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-membership-response-if-user-is-a-team-maintainer": {
"summary": "Response if user is a team maintainer",
"value": {
@@ -311099,15 +310244,6 @@
"type": "string"
}
},
- "discussion-number": {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
"security-product": {
"name": "security_product",
"in": "path",
diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml
index 9b56c35ba..82a860095 100644
--- a/descriptions/api.github.com/api.github.com.yaml
+++ b/descriptions/api.github.com/api.github.com.yaml
@@ -21036,231 +21036,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#list-discussions
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#create-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- 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:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#get-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#update-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#delete-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/invitations":
get:
summary: List pending team invitations
@@ -47223,235 +46998,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- 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]
- > **Endpoint closing down notice:** 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.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- 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:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- 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]
- > **Endpoint closing down notice:** 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.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth 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:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -88142,89 +87688,6 @@ components:
- members_count
- repos_count
- organization
- team-discussion:
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form conversation
- within a team.
- type: object
- properties:
- author:
- "$ref": "#/components/schemas/nullable-simple-user"
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a team
"
- body_version:
- description: The current version of the body content. If provided, this
- update operation will be rejected if the given version does not match
- the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted to team
- members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions:
- "$ref": "#/components/schemas/reaction-rollup"
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
team-membership:
title: Team Membership
description: Team Membership
@@ -217766,144 +217229,6 @@ components:
created_at: '2008-01-14T04:33:35Z'
updated_at: '2017-08-17T12:37:15Z'
type: Organization
- team-discussion-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: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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
- 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-membership-response-if-user-is-a-team-maintainer:
summary: Response if user is a team maintainer
value:
@@ -236088,13 +235413,6 @@ components:
required: true
schema:
type: string
- discussion-number:
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
security-product:
name: security_product
in: path
diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json
index b577e364b..da590311b 100644
--- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json
+++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json
@@ -199229,17 +199229,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
+ "/orgs/{org}/teams/{team_slug}/invitations": {
"get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussions-in-org",
+ "operationId": "teams/list-pending-invitations-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions"
+ "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
},
"parameters": [
{
@@ -199260,20 +199260,6 @@
"type": "string"
}
},
- {
- "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).\"",
@@ -199291,15 +199277,6 @@
"type": "integer",
"default": 1
}
- },
- {
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
- "schema": {
- "type": "string"
- }
}
],
"responses": {
@@ -199310,11 +199287,37 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -199436,143 +199439,34 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ ]
},
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
+ "team_count": {
"type": "integer"
},
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
+ "node_id": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
},
- "updated_at": {
+ "invitation_teams_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
},
- "url": {
+ "invitation_source": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/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"
- ]
+ "example": "\"member\""
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
+ "id",
+ "login",
+ "email",
+ "role",
"created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
]
}
},
@@ -199580,52 +199474,37 @@
"default": {
"value": [
{
- "author": {
- "login": "octocat",
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
"gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
"type": "User",
"site_admin": false
},
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
}
]
}
@@ -199646,19 +199525,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
}
- },
- "post": {
- "summary": "Create a discussion",
- "description": "Creates 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\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-in-org",
+ "operationId": "teams/list-members-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion"
+ "url": "https://docs.github.com/rest/teams/members#list-team-members"
},
"parameters": [
{
@@ -199678,320 +199559,177 @@
"schema": {
"type": "string"
}
- }
- ],
- "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."
- }
- }
- }
+ },
+ {
+ "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": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
+ "email": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ }
},
"examples": {
"default": {
- "value": {
- "author": {
+ "value": [
+ {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -200010,60 +199748,41 @@
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
}
- }
+ ]
}
}
}
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
}
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
"get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-in-org",
+ "operationId": "teams/get-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion"
+ "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
},
"parameters": [
{
@@ -200085,12 +199804,12 @@
}
},
{
- "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"
}
}
],
@@ -200100,344 +199819,73 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
+ "url": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
+ "format": "uri"
},
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/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"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
"value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "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": "discussions"
+ "subcategory": "members"
}
},
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-in-org",
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion"
+ "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -200459,12 +199907,12 @@
}
},
{
- "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"
}
}
],
@@ -200475,20 +199923,22 @@
"schema": {
"type": "object",
"properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
+ "role": {
"type": "string",
- "description": "The discussion post's body text."
+ "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": {
- "title": "Welcome to our first team post"
+ "role": "maintainer"
}
}
}
@@ -200501,1111 +199951,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/invitations": {
- "get": {
- "summary": "List pending team invitations",
- "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-pending-invitations-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Organization Invitation",
- "description": "Organization Invitation",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "login": {
- "type": "string",
- "nullable": true
- },
- "email": {
- "type": "string",
- "nullable": true
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "failed_at": {
- "type": "string",
- "nullable": true
- },
- "failed_reason": {
- "type": "string",
- "nullable": true
- },
- "inviter": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "team_count": {
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
- },
- "invitation_teams_url": {
- "type": "string",
- "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
- },
- "invitation_source": {
- "type": "string",
- "example": "\"member\""
- }
- },
- "required": [
- "id",
- "login",
- "email",
- "role",
- "created_at",
- "inviter",
- "team_count",
- "invitation_teams_url",
- "node_id"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "id": 1,
- "login": "monalisa",
- "node_id": "MDQ6VXNlcjE=",
- "email": "octocat@github.com",
- "role": "direct_member",
- "created_at": "2016-11-30T06:46:10-08:00",
- "failed_at": "",
- "failed_reason": "",
- "inviter": {
- "login": "other_user",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/other_user_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/other_user",
- "html_url": "https://github.com/other_user",
- "followers_url": "https://api.github.com/users/other_user/followers",
- "following_url": "https://api.github.com/users/other_user/following{/other_user}",
- "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
- "organizations_url": "https://api.github.com/users/other_user/orgs",
- "repos_url": "https://api.github.com/users/other_user/repos",
- "events_url": "https://api.github.com/users/other_user/events{/privacy}",
- "received_events_url": "https://api.github.com/users/other_user/received_events",
- "type": "User",
- "site_admin": false
- },
- "team_count": 2,
- "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
- "invitation_source": "member"
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/members": {
- "get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-members-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#list-team-members"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
"url": {
@@ -527688,1620 +526035,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- },
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
- }
- },
- "required": [
- "title",
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml
index 5668f0183..8c8220213 100644
--- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml
+++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml
@@ -1021,7 +1021,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &642
+ - &639
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -8796,7 +8796,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
- - &478
+ - &475
name: has
in: query
description: |-
@@ -8912,7 +8912,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &479
+ security_advisory: &476
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -9174,14 +9174,14 @@ paths:
format: date-time
readOnly: true
nullable: true
- auto_dismissed_at: &480
+ auto_dismissed_at: &477
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &481
+ dismissal_request: &478
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -10543,7 +10543,7 @@ paths:
properties:
action:
type: string
- discussion: &736
+ discussion: &731
title: Discussion
description: A Discussion in a repository.
type: object
@@ -10910,7 +10910,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &532
+ properties: &529
id:
type: integer
format: int64
@@ -11287,7 +11287,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &654
+ sub_issues_summary: &651
title: Sub-issues Summary
type: object
properties:
@@ -11307,7 +11307,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &655
+ issue_dependencies_summary: &652
title: Issue Dependencies Summary
type: object
properties:
@@ -11326,7 +11326,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &656
+ items: &653
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -11387,7 +11387,7 @@ paths:
- node_id
- data_type
- value
- required: &533
+ required: &530
- assignee
- closed_at
- comments
@@ -11425,7 +11425,7 @@ paths:
action:
type: string
issue: *75
- comment: &528
+ comment: &525
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -12144,7 +12144,7 @@ paths:
type: string
release:
allOf:
- - &587
+ - &584
title: Release
description: A release.
type: object
@@ -12215,7 +12215,7 @@ paths:
author: *4
assets:
type: array
- items: &588
+ items: &585
title: Release Asset
description: Data related to a release.
type: object
@@ -12806,7 +12806,7 @@ paths:
url:
type: string
format: uri
- user: &664
+ user: &659
title: Public User
description: Public User
type: object
@@ -16111,14 +16111,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &327
+ - &324
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &328
+ - &325
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -16180,7 +16180,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &331
+ '301': &328
description: Moved permanently
content:
application/json:
@@ -16202,7 +16202,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &561
+ - &558
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -16210,7 +16210,7 @@ paths:
schema:
type: boolean
default: false
- - &562
+ - &559
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -16220,7 +16220,7 @@ paths:
type: boolean
default: false
- *82
- - &563
+ - &560
name: before
description: 'Only show notifications updated before the given time. This
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
@@ -16694,7 +16694,7 @@ paths:
- url
- subscription_url
examples:
- default: &564
+ default: &561
value:
- id: '1'
repository:
@@ -17708,7 +17708,7 @@ paths:
- property_name
- value
examples:
- default: &570
+ default: &567
value:
- property_name: environment
value: production
@@ -17758,7 +17758,7 @@ paths:
required:
- properties
examples:
- default: &571
+ default: &568
value:
properties:
- property_name: environment
@@ -18319,7 +18319,7 @@ paths:
required: false
schema:
type: string
- - &713
+ - &708
name: model
description: The model name to query usage for. The name is not case sensitive.
in: query
@@ -18465,7 +18465,7 @@ paths:
parameters:
- *68
- *115
- - &714
+ - &709
name: month
description: If specified, only return results for a single month. The value
of `month` is an integer between `1` and `12`. If no year is specified the
@@ -18577,7 +18577,7 @@ paths:
- *115
- *117
- *116
- - &715
+ - &710
name: repository
description: The repository name to query for usage in the format owner/repository.
in: query
@@ -18585,7 +18585,7 @@ paths:
schema:
type: string
- *118
- - &716
+ - &711
name: sku
description: The SKU to query for usage.
in: query
@@ -19487,7 +19487,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &338
+ items: &335
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -20679,7 +20679,7 @@ paths:
- all
- local_only
- selected
- selected_actions_url: &344
+ selected_actions_url: &341
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`
@@ -20762,7 +20762,7 @@ paths:
description: Response
content:
application/json:
- schema: &348
+ schema: &345
type: object
properties:
days:
@@ -20804,7 +20804,7 @@ paths:
required: true
content:
application/json:
- schema: &349
+ schema: &346
type: object
properties:
days:
@@ -20861,7 +20861,7 @@ paths:
required:
- approval_policy
examples:
- default: &350
+ default: &347
value:
approval_policy: first_time_contributors
'404': *6
@@ -20920,7 +20920,7 @@ paths:
description: Response
content:
application/json:
- schema: &351
+ schema: &348
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -20974,7 +20974,7 @@ paths:
required: true
content:
application/json:
- schema: &352
+ schema: &349
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -21609,7 +21609,7 @@ paths:
description: Response
content:
application/json:
- schema: &353
+ schema: &350
type: object
properties:
default_workflow_permissions: &145
@@ -21660,7 +21660,7 @@ paths:
required: false
content:
application/json:
- schema: &354
+ schema: &351
type: object
properties:
default_workflow_permissions: *145
@@ -22149,7 +22149,7 @@ paths:
type: array
items: *152
examples:
- default: &667
+ default: &662
value:
total_count: 1
repositories:
@@ -22791,7 +22791,7 @@ paths:
application/json:
schema:
type: array
- items: &355
+ items: &352
title: Runner Application
description: Runner Application
type: object
@@ -22816,7 +22816,7 @@ paths:
- download_url
- filename
examples:
- default: &356
+ default: &353
value:
- os: osx
architecture: x64
@@ -22902,7 +22902,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': &357
+ '201': &354
description: Response
content:
application/json:
@@ -23013,7 +23013,7 @@ paths:
- token
- expires_at
examples:
- default: &358
+ default: &355
value:
token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-22T12:13:35.123-08:00'
@@ -23052,7 +23052,7 @@ paths:
application/json:
schema: *156
examples:
- default: &359
+ default: &356
value:
token: AABF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-29T12:13:35.123-08:00'
@@ -23086,7 +23086,7 @@ paths:
application/json:
schema: *154
examples:
- default: &360
+ default: &357
value:
id: 23
name: MBP
@@ -23312,7 +23312,7 @@ paths:
- *68
- *153
responses:
- '200': &361
+ '200': &358
description: Response
content:
application/json:
@@ -23369,7 +23369,7 @@ paths:
parameters:
- *68
- *153
- - &362
+ - &359
name: name
description: The name of a self-hosted runner's custom label.
in: path
@@ -23499,7 +23499,7 @@ paths:
description: Response
content:
application/json:
- schema: &374
+ schema: &371
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -23528,7 +23528,7 @@ paths:
- key_id
- key
examples:
- default: &375
+ default: &372
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -23941,7 +23941,7 @@ paths:
url: https://docs.github.com/rest/actions/variables#list-organization-variables
parameters:
- *68
- - &343
+ - &340
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)."
@@ -25078,12 +25078,12 @@ paths:
required:
- subject_digests
examples:
- default: &695
+ default: &690
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &696
+ withPredicateType: &691
value:
subject_digests:
- sha256:abc123
@@ -25141,7 +25141,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &697
+ default: &692
value:
attestations_subject_digests:
- sha256:abc:
@@ -25490,7 +25490,7 @@ paths:
initiator:
type: string
examples:
- default: &388
+ default: &385
value:
attestations:
- bundle:
@@ -26419,7 +26419,7 @@ paths:
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
parameters:
- *68
- - &413
+ - &410
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`,
@@ -26429,7 +26429,7 @@ paths:
schema: &177
type: string
description: The name of the tool used to generate the code scanning analysis.
- - &414
+ - &411
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
@@ -26452,7 +26452,7 @@ paths:
be returned.
in: query
required: false
- schema: &416
+ schema: &413
type: string
description: State of a code scanning alert.
enum:
@@ -26475,7 +26475,7 @@ paths:
be returned.
in: query
required: false
- schema: &417
+ schema: &414
type: string
description: Severity of a code scanning alert.
enum:
@@ -26509,7 +26509,7 @@ paths:
updated_at: *172
url: *173
html_url: *174
- instances_url: &418
+ instances_url: &415
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -26532,7 +26532,7 @@ paths:
required: *21
nullable: true
dismissed_at: *176
- dismissed_reason: &419
+ dismissed_reason: &416
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -26541,13 +26541,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &420
+ dismissed_comment: &417
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &421
+ rule: &418
type: object
properties:
id:
@@ -26600,7 +26600,7 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &422
+ tool: &419
type: object
properties:
name: *177
@@ -26610,26 +26610,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *178
- most_recent_instance: &423
+ most_recent_instance: &420
type: object
properties:
- ref: &415
+ ref: &412
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &433
+ analysis_key: &430
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: &434
+ environment: &431
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: &435
+ category: &432
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -26643,7 +26643,7 @@ paths:
properties:
text:
type: string
- location: &436
+ location: &433
type: object
description: Describe a region within a file for the alert.
properties:
@@ -26664,7 +26664,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: &437
+ items: &434
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -27954,7 +27954,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &449
+ properties: &446
name:
type: string
description: The name of the machine.
@@ -27996,7 +27996,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &450
+ required: &447
- name
- display_name
- operating_system
@@ -28864,7 +28864,7 @@ paths:
- updated_at
- visibility
examples:
- default: &451
+ default: &448
value:
total_count: 2
secrets:
@@ -28902,7 +28902,7 @@ paths:
description: Response
content:
application/json:
- schema: &452
+ schema: &449
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -28931,7 +28931,7 @@ paths:
- key_id
- key
examples:
- default: &453
+ default: &450
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -28963,7 +28963,7 @@ paths:
application/json:
schema: *186
examples:
- default: &455
+ default: &452
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -30576,7 +30576,7 @@ paths:
description: Response
content:
application/json:
- schema: &484
+ schema: &481
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -30593,7 +30593,7 @@ paths:
- key_id
- key
examples:
- default: &485
+ default: &482
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -32393,7 +32393,7 @@ paths:
application/json:
schema: *22
examples:
- default: &523
+ default: &520
value:
id: 1
account:
@@ -32618,7 +32618,7 @@ paths:
required: true
content:
application/json:
- schema: &524
+ schema: &521
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -33471,7 +33471,7 @@ paths:
application/json:
schema: *232
examples:
- default: &448
+ default: &445
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -34720,7 +34720,7 @@ paths:
parameters:
- *68
- *239
- - &680
+ - &675
name: repo_name
description: repo_name parameter
in: path
@@ -35759,7 +35759,7 @@ paths:
- nuget
- container
- *68
- - &681
+ - &676
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -35800,7 +35800,7 @@ paths:
default: *246
'403': *29
'401': *25
- '400': &683
+ '400': &678
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -37592,7 +37592,7 @@ paths:
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: &767
+ properties: &762
id:
type: number
description: The unique identifier of the status update.
@@ -37640,7 +37640,7 @@ paths:
example: The project is off to a great start!
type: string
nullable: true
- required: &768
+ required: &763
- id
- node_id
- created_at
@@ -37854,7 +37854,7 @@ paths:
content:
oneOf:
- *75
- - &465
+ - &462
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -38083,7 +38083,7 @@ paths:
- review_comment
- self
author_association: *76
- auto_merge: &573
+ auto_merge: &570
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -38458,7 +38458,7 @@ paths:
- updated_at
- project_url
examples:
- default: &700
+ default: &695
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -38635,7 +38635,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &701
+ items: &696
type: object
properties:
name:
@@ -38671,7 +38671,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &702
+ iteration_configuration: &697
type: object
description: The configuration for iteration fields.
properties:
@@ -38720,7 +38720,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &703
+ single_select_field: &698
summary: Create a single select field
value:
name: Priority
@@ -38747,7 +38747,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &704
+ iteration_field: &699
summary: Create an iteration field
value:
name: Sprint
@@ -38773,7 +38773,7 @@ paths:
application/json:
schema: *267
examples:
- text_field: &705
+ text_field: &700
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -38782,7 +38782,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-05-15T08:00:00Z'
updated_at: '2022-05-15T08:00:00Z'
- number_field: &706
+ number_field: &701
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -38791,7 +38791,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-01T14:30:00Z'
updated_at: '2022-06-01T14:30:00Z'
- date_field: &707
+ date_field: &702
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -38800,7 +38800,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-10T09:15:00Z'
updated_at: '2022-06-10T09:15:00Z'
- single_select_field: &708
+ single_select_field: &703
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -38834,7 +38834,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &709
+ iteration_field: &704
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -38880,7 +38880,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization
parameters:
- *263
- - &710
+ - &705
name: field_id
description: The unique identifier of the field.
in: path
@@ -38895,7 +38895,7 @@ paths:
application/json:
schema: *267
examples:
- default: &711
+ default: &706
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -40021,7 +40021,7 @@ paths:
parameters:
- *263
- *68
- - &712
+ - &707
name: view_number
description: The number that identifies the project view.
in: path
@@ -40933,7 +40933,7 @@ paths:
description: Response
content:
application/json:
- schema: &330
+ schema: &327
title: Full Repository
description: Full Repository
type: object
@@ -41326,7 +41326,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &470
+ properties: &467
url:
type: string
format: uri
@@ -41342,7 +41342,7 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &471
+ required: &468
- url
- key
- name
@@ -41431,7 +41431,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &332
+ default: &329
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -41952,7 +41952,7 @@ paths:
- *68
- *17
- *19
- - &595
+ - &592
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -42233,7 +42233,7 @@ paths:
- repository_property
rules:
type: array
- items: &596
+ items: &593
title: Repository Rule
type: object
description: A repository rule.
@@ -42295,7 +42295,7 @@ paths:
type: string
enum:
- required_linear_history
- - &594
+ - &591
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -43191,7 +43191,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *68
- - &597
+ - &594
name: ref
description: The name of the ref. Cannot contain wildcard characters. Optionally
prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit
@@ -43206,7 +43206,7 @@ paths:
in: query
schema:
type: string
- - &598
+ - &595
name: time_period
description: |-
The time period to filter by.
@@ -43222,14 +43222,14 @@ paths:
- week
- month
default: day
- - &599
+ - &596
name: actor_name
description: The handle for the GitHub user account to filter on. When specified,
only rule evaluations triggered by this actor will be returned.
in: query
schema:
type: string
- - &600
+ - &597
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -43249,7 +43249,7 @@ paths:
description: Response
content:
application/json:
- schema: &601
+ schema: &598
title: Rule Suites
description: Response
type: array
@@ -43304,7 +43304,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &602
+ default: &599
value:
- id: 21
actor_id: 12
@@ -43348,7 +43348,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *68
- - &603
+ - &600
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -43364,7 +43364,7 @@ paths:
description: Response
content:
application/json:
- schema: &604
+ schema: &601
title: Rule Suite
description: Response
type: object
@@ -43463,7 +43463,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &605
+ default: &602
value:
id: 21
actor_id: 12
@@ -43709,7 +43709,7 @@ paths:
type: string
format: date-time
examples:
- default: &607
+ default: &604
value:
- version_id: 3
actor:
@@ -43762,7 +43762,7 @@ paths:
description: Response
content:
application/json:
- schema: &608
+ schema: &605
allOf:
- *310
- type: object
@@ -43834,7 +43834,7 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
parameters:
- *68
- - &609
+ - &606
name: state
in: query
description: Set to `open` or `resolved` to only list secret scanning alerts
@@ -43845,7 +43845,7 @@ paths:
enum:
- open
- resolved
- - &610
+ - &607
name: secret_type
in: query
description: A comma-separated list of secret types to return. All default
@@ -43855,7 +43855,7 @@ paths:
required: false
schema:
type: string
- - &611
+ - &608
name: resolution
in: query
description: A comma-separated list of resolutions. Only secret scanning alerts
@@ -43864,7 +43864,7 @@ paths:
required: false
schema:
type: string
- - &612
+ - &609
name: assignee
in: query
description: Filters alerts by assignee. Use `*` to get all assigned alerts,
@@ -43883,7 +43883,7 @@ paths:
all-unassigned:
value: none
summary: Filter for all unassigned alerts
- - &613
+ - &610
name: sort
description: The property to sort the results by. `created` means when the
alert was created. `updated` means when the alert was updated or resolved.
@@ -43898,7 +43898,7 @@ paths:
- *53
- *19
- *17
- - &614
+ - &611
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -43908,7 +43908,7 @@ paths:
required: false
schema:
type: string
- - &615
+ - &612
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -43918,7 +43918,7 @@ paths:
required: false
schema:
type: string
- - &616
+ - &613
name: validity
in: query
description: A comma-separated list of validities that, when present, will
@@ -43927,7 +43927,7 @@ paths:
required: false
schema:
type: string
- - &617
+ - &614
name: is_publicly_leaked
in: query
description: A boolean value representing whether or not to filter alerts
@@ -43936,7 +43936,7 @@ paths:
schema:
type: boolean
default: false
- - &618
+ - &615
name: is_multi_repo
in: query
description: A boolean value representing whether or not to filter alerts
@@ -43945,7 +43945,7 @@ paths:
schema:
type: boolean
default: false
- - &619
+ - &616
name: hide_secret
in: query
description: A boolean value representing whether or not to hide literal secrets
@@ -43980,14 +43980,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &620
+ state: &617
description: Sets the state of the secret scanning alert. You
must provide `resolution` when you set the state to `resolved`.
type: string
enum:
- open
- resolved
- resolution: &621
+ resolution: &618
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -44094,8 +44094,8 @@ paths:
pull request.
'
- oneOf: &622
- - &624
+ oneOf: &619
+ - &621
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -44147,7 +44147,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &625
+ - &622
description: Represents a 'wiki_commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository wiki.
@@ -44202,7 +44202,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &626
+ - &623
description: Represents an 'issue_title' secret scanning location
type. This location type shows that a secret was detected
in the title of an issue.
@@ -44216,7 +44216,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &627
+ - &624
description: Represents an 'issue_body' secret scanning location
type. This location type shows that a secret was detected
in the body of an issue.
@@ -44230,7 +44230,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &628
+ - &625
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on an issue.
@@ -44244,7 +44244,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &629
+ - &626
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a discussion.
@@ -44258,7 +44258,7 @@ paths:
example: https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &630
+ - &627
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a discussion.
@@ -44272,7 +44272,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &631
+ - &628
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a discussion.
@@ -44286,7 +44286,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &632
+ - &629
description: Represents a 'pull_request_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a pull request.
@@ -44300,7 +44300,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &633
+ - &630
description: Represents a 'pull_request_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a pull request.
@@ -44314,7 +44314,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &634
+ - &631
description: Represents a 'pull_request_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a pull request.
@@ -44328,7 +44328,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &635
+ - &632
description: Represents a 'pull_request_review' secret scanning
location type. This location type shows that a secret was
detected in a review on a pull request.
@@ -44342,7 +44342,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &636
+ - &633
description: Represents a 'pull_request_review_comment' secret
scanning location type. This location type shows that a
secret was detected in a review comment on a pull request.
@@ -44840,7 +44840,7 @@ paths:
application/json:
schema:
type: array
- items: &640
+ items: &637
description: A repository security advisory.
type: object
properties:
@@ -45131,7 +45131,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &641
+ default: &638
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -46908,454 +46908,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#list-discussions
- parameters:
- - *68
- - *69
- - *53
- - *17
- - *19
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &323
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form
- conversation within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *20
- required: *21
- nullable: true
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a
- team
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned
- for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted
- to team members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions: *77
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
- examples:
- default: &658
- value:
- - author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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: *59
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#create-a-discussion
- parameters:
- - *68
- - *69
- 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: *323
- examples:
- default: &324
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Our first team post
- updated_at: '2018-01-25T18:56:31Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#get-a-discussion
- parameters:
- - *68
- - *69
- - &325
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *323
- examples:
- default: *324
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#update-a-discussion
- parameters:
- - *68
- - *69
- - *325
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *323
- examples:
- default: &659
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Welcome to our first team post
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#delete-a-discussion
- parameters:
- - *68
- - *69
- - *325
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/invitations":
get:
summary: List pending team invitations
@@ -47468,7 +47020,7 @@ paths:
description: Response
content:
application/json:
- schema: &326
+ schema: &323
title: Team Membership
description: Team Membership
type: object
@@ -47495,7 +47047,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &660
+ response-if-user-is-a-team-maintainer: &655
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -47558,9 +47110,9 @@ paths:
description: Response
content:
application/json:
- schema: *326
+ schema: *323
examples:
- response-if-users-membership-with-team-is-now-pending: &661
+ response-if-users-membership-with-team-is-now-pending: &656
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -47667,14 +47219,14 @@ paths:
parameters:
- *68
- *69
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &662
+ schema: &657
title: Team Repository
description: A team's access to a repository.
type: object
@@ -48245,8 +47797,8 @@ paths:
parameters:
- *68
- *69
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -48293,8 +47845,8 @@ paths:
parameters:
- *68
- *69
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -48331,7 +47883,7 @@ paths:
type: array
items: *189
examples:
- response-if-child-teams-exist: &663
+ response-if-child-teams-exist: &658
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -48485,7 +48037,7 @@ paths:
resources:
type: object
properties:
- core: &329
+ core: &326
title: Rate Limit
type: object
properties:
@@ -48502,21 +48054,21 @@ paths:
- remaining
- reset
- used
- graphql: *329
- search: *329
- code_search: *329
- source_import: *329
- integration_manifest: *329
- code_scanning_upload: *329
- actions_runner_registration: *329
- scim: *329
- dependency_snapshots: *329
- dependency_sbom: *329
- code_scanning_autofix: *329
+ graphql: *326
+ search: *326
+ code_search: *326
+ source_import: *326
+ integration_manifest: *326
+ code_scanning_upload: *326
+ actions_runner_registration: *326
+ scim: *326
+ dependency_snapshots: *326
+ dependency_sbom: *326
+ code_scanning_autofix: *326
required:
- core
- search
- rate: *329
+ rate: *326
required:
- rate
- resources
@@ -48621,14 +48173,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
default-response:
summary: Default response
@@ -49129,7 +48681,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *331
+ '301': *328
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -49147,8 +48699,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#update-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -49395,10 +48947,10 @@ paths:
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
- '307': &333
+ default: *329
+ '307': &330
description: Temporary Redirect
content:
application/json:
@@ -49427,8 +48979,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#delete-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -49450,7 +49002,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository
- '307': *333
+ '307': *330
'404': *6
'409': *52
x-github:
@@ -49474,11 +49026,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
- - &366
+ - &363
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -49501,7 +49053,7 @@ paths:
type: integer
artifacts:
type: array
- items: &334
+ items: &331
title: Artifact
description: An artifact
type: object
@@ -49579,7 +49131,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &367
+ default: &364
value:
total_count: 2
artifacts:
@@ -49640,9 +49192,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#get-an-artifact
parameters:
- - *327
- - *328
- - &335
+ - *324
+ - *325
+ - &332
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -49654,7 +49206,7 @@ paths:
description: Response
content:
application/json:
- schema: *334
+ schema: *331
examples:
default:
value:
@@ -49692,9 +49244,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact
parameters:
- - *327
- - *328
- - *335
+ - *324
+ - *325
+ - *332
responses:
'204':
description: Response
@@ -49718,9 +49270,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#download-an-artifact
parameters:
- - *327
- - *328
- - *335
+ - *324
+ - *325
+ - *332
- name: archive_format
in: path
required: true
@@ -49734,7 +49286,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': &527
+ '410': &524
description: Gone
content:
application/json:
@@ -49759,14 +49311,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &336
+ schema: &333
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -49799,13 +49351,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *336
+ schema: *333
examples:
selected_actions: *42
responses:
@@ -49834,14 +49386,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &337
+ schema: &334
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -49874,13 +49426,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *337
+ schema: *334
examples:
selected_actions: *44
responses:
@@ -49911,14 +49463,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *338
+ schema: *335
examples:
default:
value:
@@ -49944,11 +49496,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
- - &339
+ - &336
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
@@ -49982,7 +49534,7 @@ paths:
description: Response
content:
application/json:
- schema: &340
+ schema: &337
title: Repository actions caches
description: Repository actions caches
type: object
@@ -50024,7 +49576,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &341
+ default: &338
value:
total_count: 1
actions_caches:
@@ -50056,23 +49608,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:
- - *327
- - *328
+ - *324
+ - *325
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *339
+ - *336
responses:
'200':
description: Response
content:
application/json:
- schema: *340
+ schema: *337
examples:
- default: *341
+ default: *338
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -50092,8 +49644,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:
- - *327
- - *328
+ - *324
+ - *325
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -50124,9 +49676,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *327
- - *328
- - &342
+ - *324
+ - *325
+ - &339
name: job_id
description: The unique identifier of the job.
in: path
@@ -50138,7 +49690,7 @@ paths:
description: Response
content:
application/json:
- schema: &370
+ schema: &367
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -50445,9 +49997,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *327
- - *328
- - *342
+ - *324
+ - *325
+ - *339
responses:
'302':
description: Response
@@ -50475,9 +50027,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *327
- - *328
- - *342
+ - *324
+ - *325
+ - *339
requestBody:
required: false
content:
@@ -50522,8 +50074,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Status response
@@ -50573,8 +50125,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -50637,8 +50189,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -50656,7 +50208,7 @@ paths:
type: integer
secrets:
type: array
- items: &372
+ items: &369
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -50676,7 +50228,7 @@ paths:
- created_at
- updated_at
examples:
- default: &373
+ default: &370
value:
total_count: 2
secrets:
@@ -50709,9 +50261,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables
parameters:
- - *327
- - *328
- - *343
+ - *324
+ - *325
+ - *340
- *19
responses:
'200':
@@ -50728,7 +50280,7 @@ paths:
type: integer
variables:
type: array
- items: &376
+ items: &373
title: Actions Variable
type: object
properties:
@@ -50758,7 +50310,7 @@ paths:
- created_at
- updated_at
examples:
- default: &377
+ default: &374
value:
total_count: 2
variables:
@@ -50791,8 +50343,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -50801,11 +50353,11 @@ paths:
schema:
type: object
properties:
- enabled: &345
+ enabled: &342
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *137
- selected_actions_url: *344
+ selected_actions_url: *341
sha_pinning_required: *138
required:
- enabled
@@ -50834,8 +50386,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -50846,7 +50398,7 @@ paths:
schema:
type: object
properties:
- enabled: *345
+ enabled: *342
allowed_actions: *137
sha_pinning_required: *138
required:
@@ -50878,14 +50430,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &346
+ schema: &343
type: object
properties:
access_level:
@@ -50902,7 +50454,7 @@ paths:
required:
- access_level
examples:
- default: &347
+ default: &344
value:
access_level: organization
x-github:
@@ -50926,15 +50478,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *346
+ schema: *343
examples:
- default: *347
+ default: *344
responses:
'204':
description: Response
@@ -50958,14 +50510,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *348
+ schema: *345
examples:
default:
value:
@@ -50989,8 +50541,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Empty response for successful settings update
@@ -51000,7 +50552,7 @@ paths:
required: true
content:
application/json:
- schema: *349
+ schema: *346
examples:
default:
summary: Set retention days
@@ -51024,8 +50576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -51033,7 +50585,7 @@ paths:
application/json:
schema: *139
examples:
- default: *350
+ default: *347
'404': *6
x-github:
enabledForGitHubApps: true
@@ -51052,8 +50604,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -51087,14 +50639,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *348
examples:
default: *140
'403': *29
@@ -51116,13 +50668,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *352
+ schema: *349
examples:
default: *140
responses:
@@ -51148,8 +50700,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -51176,8 +50728,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -51209,14 +50761,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *353
+ schema: *350
examples:
default: *147
x-github:
@@ -51239,8 +50791,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Success response
@@ -51251,7 +50803,7 @@ paths:
required: true
content:
application/json:
- schema: *354
+ schema: *351
examples:
default: *147
x-github:
@@ -51280,8 +50832,8 @@ paths:
in: query
schema:
type: string
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -51325,8 +50877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -51334,9 +50886,9 @@ paths:
application/json:
schema:
type: array
- items: *355
+ items: *352
examples:
- default: *356
+ default: *353
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51358,8 +50910,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -51402,7 +50954,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': *357
+ '201': *354
'404': *6
'422': *7
'409': *52
@@ -51433,8 +50985,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'201':
description: Response
@@ -51442,7 +50994,7 @@ paths:
application/json:
schema: *156
examples:
- default: *358
+ default: *355
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51470,8 +51022,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'201':
description: Response
@@ -51479,7 +51031,7 @@ paths:
application/json:
schema: *156
examples:
- default: *359
+ default: *356
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51501,8 +51053,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
responses:
'200':
@@ -51511,7 +51063,7 @@ paths:
application/json:
schema: *154
examples:
- default: *360
+ default: *357
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51532,8 +51084,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
responses:
'204':
@@ -51560,8 +51112,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
responses:
'200': *158
@@ -51586,8 +51138,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
requestBody:
required: true
@@ -51636,8 +51188,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
requestBody:
required: true
@@ -51687,11 +51239,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
responses:
- '200': *361
+ '200': *358
'404': *6
x-github:
githubCloudOnly: false
@@ -51718,10 +51270,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
- - *362
+ - *359
responses:
'200': *158
'404': *6
@@ -51749,9 +51301,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *327
- - *328
- - &380
+ - *324
+ - *325
+ - &377
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.
@@ -51759,7 +51311,7 @@ paths:
required: false
schema:
type: string
- - &381
+ - &378
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -51767,7 +51319,7 @@ paths:
required: false
schema:
type: string
- - &382
+ - &379
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -51776,7 +51328,7 @@ paths:
required: false
schema:
type: string
- - &383
+ - &380
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
@@ -51803,7 +51355,7 @@ paths:
- pending
- *17
- *19
- - &384
+ - &381
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)."
@@ -51812,7 +51364,7 @@ paths:
schema:
type: string
format: date-time
- - &363
+ - &360
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -51821,13 +51373,13 @@ paths:
schema:
type: boolean
default: false
- - &385
+ - &382
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &386
+ - &383
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -51850,7 +51402,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &364
+ items: &361
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -51998,7 +51550,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &408
+ properties: &405
id:
type: string
description: SHA for the commit
@@ -52049,7 +51601,7 @@ paths:
- name
- email
nullable: true
- required: &409
+ required: &406
- id
- tree_id
- message
@@ -52096,7 +51648,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &387
+ default: &384
value:
total_count: 1
workflow_runs:
@@ -52332,24 +51884,24 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *327
- - *328
- - &365
+ - *324
+ - *325
+ - &362
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *363
+ - *360
responses:
'200':
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: &368
+ default: &365
value:
id: 30433642
name: Build
@@ -52590,9 +52142,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'204':
description: Response
@@ -52615,9 +52167,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'200':
description: Response
@@ -52736,9 +52288,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:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'201':
description: Response
@@ -52771,12 +52323,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
- *17
- *19
- - *366
+ - *363
responses:
'200':
description: Response
@@ -52792,9 +52344,9 @@ paths:
type: integer
artifacts:
type: array
- items: *334
+ items: *331
examples:
- default: *367
+ default: *364
headers:
Link: *59
x-github:
@@ -52818,25 +52370,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *327
- - *328
- - *365
- - &369
+ - *324
+ - *325
+ - *362
+ - &366
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *363
+ - *360
responses:
'200':
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: *368
+ default: *365
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52859,10 +52411,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *327
- - *328
- - *365
- - *369
+ - *324
+ - *325
+ - *362
+ - *366
- *17
- *19
responses:
@@ -52880,9 +52432,9 @@ paths:
type: integer
jobs:
type: array
- items: *370
+ items: *367
examples:
- default: &371
+ default: &368
value:
total_count: 1
jobs:
@@ -52995,10 +52547,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *327
- - *328
- - *365
- - *369
+ - *324
+ - *325
+ - *362
+ - *366
responses:
'302':
description: Response
@@ -53026,9 +52578,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'202':
description: Response
@@ -53061,9 +52613,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:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
requestBody:
required: true
content:
@@ -53130,9 +52682,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'202':
description: Response
@@ -53165,9 +52717,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
- 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
@@ -53197,9 +52749,9 @@ paths:
type: integer
jobs:
type: array
- items: *370
+ items: *367
examples:
- default: *371
+ default: *368
headers:
Link: *59
x-github:
@@ -53224,9 +52776,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'302':
description: Response
@@ -53253,9 +52805,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'204':
description: Response
@@ -53282,9 +52834,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'200':
description: Response
@@ -53344,7 +52896,7 @@ paths:
items:
type: object
properties:
- type: &493
+ type: &490
type: string
description: The type of reviewer.
enum:
@@ -53429,9 +52981,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
requestBody:
required: true
content:
@@ -53478,7 +53030,7 @@ paths:
application/json:
schema:
type: array
- items: &488
+ items: &485
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -53584,7 +53136,7 @@ paths:
- created_at
- updated_at
examples:
- default: &489
+ default: &486
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -53640,9 +53192,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
requestBody:
required: false
content:
@@ -53686,9 +53238,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
requestBody:
required: false
content:
@@ -53741,9 +53293,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'200':
description: Response
@@ -53880,8 +53432,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-secrets
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -53899,9 +53451,9 @@ paths:
type: integer
secrets:
type: array
- items: *372
+ items: *369
examples:
- default: *373
+ default: *370
headers:
Link: *59
x-github:
@@ -53926,16 +53478,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *374
+ schema: *371
examples:
- default: *375
+ default: *372
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53957,17 +53509,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'200':
description: Response
content:
application/json:
- schema: *372
+ schema: *369
examples:
- default: &506
+ default: &503
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -53993,8 +53545,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
requestBody:
required: true
@@ -54052,8 +53604,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'204':
@@ -54079,9 +53631,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-variables
parameters:
- - *327
- - *328
- - *343
+ - *324
+ - *325
+ - *340
- *19
responses:
'200':
@@ -54098,9 +53650,9 @@ paths:
type: integer
variables:
type: array
- items: *376
+ items: *373
examples:
- default: *377
+ default: *374
headers:
Link: *59
x-github:
@@ -54123,8 +53675,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-a-repository-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -54176,17 +53728,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-a-repository-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
responses:
'200':
description: Response
content:
application/json:
- schema: *376
+ schema: *373
examples:
- default: &507
+ default: &504
value:
name: USERNAME
value: octocat
@@ -54212,8 +53764,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-a-repository-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
requestBody:
required: true
@@ -54256,8 +53808,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
responses:
'204':
@@ -54283,8 +53835,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#list-repository-workflows
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -54302,7 +53854,7 @@ paths:
type: integer
workflows:
type: array
- items: &378
+ items: &375
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -54409,9 +53961,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-a-workflow
parameters:
- - *327
- - *328
- - &379
+ - *324
+ - *325
+ - &376
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -54426,7 +53978,7 @@ paths:
description: Response
content:
application/json:
- schema: *378
+ schema: *375
examples:
default:
value:
@@ -54459,9 +54011,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#disable-a-workflow
parameters:
- - *327
- - *328
- - *379
+ - *324
+ - *325
+ - *376
responses:
'204':
description: Response
@@ -54486,9 +54038,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *327
- - *328
- - *379
+ - *324
+ - *325
+ - *376
responses:
'204':
description: Response
@@ -54539,9 +54091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#enable-a-workflow
parameters:
- - *327
- - *328
- - *379
+ - *324
+ - *325
+ - *376
responses:
'204':
description: Response
@@ -54568,19 +54120,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *327
- - *328
+ - *324
+ - *325
+ - *376
+ - *377
+ - *378
- *379
- *380
+ - *17
+ - *19
- *381
+ - *360
- *382
- *383
- - *17
- - *19
- - *384
- - *363
- - *385
- - *386
responses:
'200':
description: Response
@@ -54596,9 +54148,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *364
+ items: *361
examples:
- default: *387
+ default: *384
headers:
Link: *59
x-github:
@@ -54630,9 +54182,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-workflow-usage
parameters:
- - *327
- - *328
- - *379
+ - *324
+ - *325
+ - *376
responses:
'200':
description: Response
@@ -54693,8 +54245,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-activities
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *53
- *17
- *45
@@ -54858,8 +54410,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#list-assignees
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -54896,8 +54448,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: assignee
in: path
required: true
@@ -54933,8 +54485,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#create-an-attestation
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -55046,8 +54598,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#list-attestations
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *45
- *46
@@ -55104,7 +54656,7 @@ paths:
initiator:
type: string
examples:
- default: *388
+ default: *385
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -55124,8 +54676,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -55133,7 +54685,7 @@ paths:
application/json:
schema:
type: array
- items: &389
+ items: &386
title: Autolink reference
description: An autolink reference.
type: object
@@ -55187,8 +54739,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -55227,9 +54779,9 @@ paths:
description: response
content:
application/json:
- schema: *389
+ schema: *386
examples:
- default: &390
+ default: &387
value:
id: 1
key_prefix: TICKET-
@@ -55260,9 +54812,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *327
- - *328
- - &391
+ - *324
+ - *325
+ - &388
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -55274,9 +54826,9 @@ paths:
description: Response
content:
application/json:
- schema: *389
+ schema: *386
examples:
- default: *390
+ default: *387
'404': *6
x-github:
githubCloudOnly: false
@@ -55296,9 +54848,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *327
- - *328
- - *391
+ - *324
+ - *325
+ - *388
responses:
'204':
description: Response
@@ -55322,8 +54874,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response if Dependabot is enabled
@@ -55371,8 +54923,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -55393,8 +54945,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -55414,8 +54966,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#list-branches
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -55453,7 +55005,7 @@ paths:
- url
protected:
type: boolean
- protection: &393
+ protection: &390
title: Branch Protection
description: Branch Protection
type: object
@@ -55495,7 +55047,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &396
+ enforce_admins: &393
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -55510,7 +55062,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &398
+ required_pull_request_reviews: &395
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -55586,7 +55138,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &395
+ restrictions: &392
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -55863,9 +55415,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#get-a-branch
parameters:
- - *327
- - *328
- - &394
+ - *324
+ - *325
+ - &391
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).
@@ -55879,14 +55431,14 @@ paths:
description: Response
content:
application/json:
- schema: &404
+ schema: &401
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &461
+ commit: &458
title: Commit
description: Commit
type: object
@@ -55920,7 +55472,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &392
+ properties: &389
name:
type: string
example: '"Chris Wanstrath"'
@@ -55936,7 +55488,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *392
+ properties: *389
nullable: true
message:
type: string
@@ -55957,7 +55509,7 @@ paths:
required:
- sha
- url
- verification: &513
+ verification: &510
title: Verification
type: object
properties:
@@ -56027,7 +55579,7 @@ paths:
type: integer
files:
type: array
- items: &474
+ items: &471
title: Diff Entry
description: Diff Entry
type: object
@@ -56111,7 +55663,7 @@ paths:
- self
protected:
type: boolean
- protection: *393
+ protection: *390
protection_url:
type: string
format: uri
@@ -56218,7 +55770,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *331
+ '301': *328
'404': *6
x-github:
githubCloudOnly: false
@@ -56240,15 +55792,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *393
+ schema: *390
examples:
default:
value:
@@ -56442,9 +55994,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -56699,7 +56251,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &401
+ required_status_checks: &398
title: Status Check Policy
description: Status Check Policy
type: object
@@ -56851,7 +56403,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *395
+ restrictions: *392
required_conversation_resolution:
type: object
properties:
@@ -56963,9 +56515,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -56990,17 +56542,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: &397
+ default: &394
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -57022,17 +56574,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: *397
+ default: *394
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57051,9 +56603,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57078,17 +56630,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *398
+ schema: *395
examples:
- default: &399
+ default: &396
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -57184,9 +56736,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -57284,9 +56836,9 @@ paths:
description: Response
content:
application/json:
- schema: *398
+ schema: *395
examples:
- default: *399
+ default: *396
'422': *15
x-github:
githubCloudOnly: false
@@ -57307,9 +56859,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57336,17 +56888,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: &400
+ default: &397
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -57369,17 +56921,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: *400
+ default: *397
'404': *6
x-github:
githubCloudOnly: false
@@ -57399,9 +56951,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57426,17 +56978,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: &402
+ default: &399
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -57462,9 +57014,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -57516,9 +57068,9 @@ paths:
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'404': *6
'422': *15
x-github:
@@ -57540,9 +57092,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57566,9 +57118,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
@@ -57602,9 +57154,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -57671,9 +57223,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -57737,9 +57289,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
content:
application/json:
@@ -57805,15 +57357,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *395
+ schema: *392
examples:
default:
value:
@@ -57904,9 +57456,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57929,9 +57481,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
@@ -57941,7 +57493,7 @@ paths:
type: array
items: *5
examples:
- default: &403
+ default: &400
value:
- id: 1
slug: octoapp
@@ -57998,9 +57550,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58034,7 +57586,7 @@ paths:
type: array
items: *5
examples:
- default: *403
+ default: *400
'422': *15
x-github:
githubCloudOnly: false
@@ -58055,9 +57607,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58091,7 +57643,7 @@ paths:
type: array
items: *5
examples:
- default: *403
+ default: *400
'422': *15
x-github:
githubCloudOnly: false
@@ -58112,9 +57664,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58148,7 +57700,7 @@ paths:
type: array
items: *5
examples:
- default: *403
+ default: *400
'422': *15
x-github:
githubCloudOnly: false
@@ -58170,9 +57722,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
@@ -58202,9 +57754,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -58263,9 +57815,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -58324,9 +57876,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
content:
application/json:
@@ -58385,9 +57937,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
@@ -58421,9 +57973,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58481,9 +58033,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58541,9 +58093,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58603,9 +58155,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#rename-a-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58627,7 +58179,7 @@ paths:
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
default:
value:
@@ -58743,8 +58295,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#create-a-check-run
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -59023,7 +58575,7 @@ paths:
description: Response
content:
application/json:
- schema: &405
+ schema: &402
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -59143,7 +58695,7 @@ paths:
check.
type: array
items: *80
- deployment: &725
+ deployment: &720
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -59423,9 +58975,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#get-a-check-run
parameters:
- - *327
- - *328
- - &406
+ - *324
+ - *325
+ - &403
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -59437,9 +58989,9 @@ paths:
description: Response
content:
application/json:
- schema: *405
+ schema: *402
examples:
- default: &407
+ default: &404
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -59539,9 +59091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#update-a-check-run
parameters:
- - *327
- - *328
- - *406
+ - *324
+ - *325
+ - *403
requestBody:
required: true
content:
@@ -59781,9 +59333,9 @@ paths:
description: Response
content:
application/json:
- schema: *405
+ schema: *402
examples:
- default: *407
+ default: *404
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -59803,9 +59355,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-run-annotations
parameters:
- - *327
- - *328
- - *406
+ - *324
+ - *325
+ - *403
- *17
- *19
responses:
@@ -59900,9 +59452,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
parameters:
- - *327
- - *328
- - *406
+ - *324
+ - *325
+ - *403
responses:
'201':
description: Response
@@ -59946,8 +59498,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#create-a-check-suite
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -59969,7 +59521,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &410
+ schema: &407
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -60055,12 +59607,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &751
+ head_commit: &746
title: Simple Commit
description: A commit.
type: object
- properties: *408
- required: *409
+ properties: *405
+ required: *406
latest_check_runs_count:
type: integer
check_runs_url:
@@ -60088,7 +59640,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &411
+ default: &408
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -60379,9 +59931,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *410
+ schema: *407
examples:
- default: *411
+ default: *408
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60400,8 +59952,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -60710,9 +60262,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#get-a-check-suite
parameters:
- - *327
- - *328
- - &412
+ - *324
+ - *325
+ - &409
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -60724,9 +60276,9 @@ paths:
description: Response
content:
application/json:
- schema: *410
+ schema: *407
examples:
- default: *411
+ default: *408
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60749,17 +60301,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *327
- - *328
- - *412
- - &467
+ - *324
+ - *325
+ - *409
+ - &464
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &468
+ - &465
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -60798,9 +60350,9 @@ paths:
type: integer
check_runs:
type: array
- items: *405
+ items: *402
examples:
- default: &469
+ default: &466
value:
total_count: 1
check_runs:
@@ -60902,9 +60454,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *327
- - *328
- - *412
+ - *324
+ - *325
+ - *409
responses:
'201':
description: Response
@@ -60937,21 +60489,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *327
- - *328
- - *413
- - *414
+ - *324
+ - *325
+ - *410
+ - *411
- *19
- *17
- - &431
+ - &428
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: *415
- - &432
+ schema: *412
+ - &429
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -60976,13 +60528,13 @@ paths:
be returned.
in: query
required: false
- schema: *416
+ schema: *413
- name: severity
description: If specified, only code scanning alerts with this severity will
be returned.
in: query
required: false
- schema: *417
+ schema: *414
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -61006,7 +60558,7 @@ paths:
updated_at: *172
url: *173
html_url: *174
- instances_url: *418
+ instances_url: *415
state: *179
fixed_at: *175
dismissed_by:
@@ -61017,11 +60569,11 @@ paths:
required: *21
nullable: true
dismissed_at: *176
- dismissed_reason: *419
- dismissed_comment: *420
- rule: *421
- tool: *422
- most_recent_instance: *423
+ dismissed_reason: *416
+ dismissed_comment: *417
+ rule: *418
+ tool: *419
+ most_recent_instance: *420
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -61147,7 +60699,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &424
+ '403': &421
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -61174,9 +60726,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *327
- - *328
- - &425
+ - *324
+ - *325
+ - &422
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -61190,7 +60742,7 @@ paths:
description: Response
content:
application/json:
- schema: &426
+ schema: &423
type: object
properties:
number: *170
@@ -61198,7 +60750,7 @@ paths:
updated_at: *172
url: *173
html_url: *174
- instances_url: *418
+ instances_url: *415
state: *179
fixed_at: *175
dismissed_by:
@@ -61209,8 +60761,8 @@ paths:
required: *21
nullable: true
dismissed_at: *176
- dismissed_reason: *419
- dismissed_comment: *420
+ dismissed_reason: *416
+ dismissed_comment: *417
rule:
type: object
properties:
@@ -61264,8 +60816,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *422
- most_recent_instance: *423
+ tool: *419
+ most_recent_instance: *420
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -61364,7 +60916,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -61384,9 +60936,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
requestBody:
required: true
content:
@@ -61401,8 +60953,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *419
- dismissed_comment: *420
+ dismissed_reason: *416
+ dismissed_comment: *417
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -61430,7 +60982,7 @@ paths:
description: Response
content:
application/json:
- schema: *426
+ schema: *423
examples:
default:
value:
@@ -61506,7 +61058,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &430
+ '403': &427
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -61533,15 +61085,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:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
responses:
'200':
description: Response
content:
application/json:
- schema: &427
+ schema: &424
type: object
properties:
status:
@@ -61567,13 +61119,13 @@ paths:
- description
- started_at
examples:
- default: &428
+ default: &425
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &429
+ '400': &426
description: Bad Request
content:
application/json:
@@ -61584,7 +61136,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': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -61609,29 +61161,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:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
responses:
'200':
description: OK
content:
application/json:
- schema: *427
+ schema: *424
examples:
- default: *428
+ default: *425
'202':
description: Accepted
content:
application/json:
- schema: *427
+ schema: *424
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *429
+ '400': *426
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -61663,9 +61215,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:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
requestBody:
required: false
content:
@@ -61710,8 +61262,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *429
- '403': *430
+ '400': *426
+ '403': *427
'404': *6
'422':
description: Unprocessable Entity
@@ -61735,13 +61287,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
- *19
- *17
- - *431
- - *432
+ - *428
+ - *429
responses:
'200':
description: Response
@@ -61752,10 +61304,10 @@ paths:
items:
type: object
properties:
- ref: *415
- analysis_key: *433
- environment: *434
- category: *435
+ ref: *412
+ analysis_key: *430
+ environment: *431
+ category: *432
state:
type: string
description: State of a code scanning alert instance.
@@ -61770,7 +61322,7 @@ paths:
properties:
text:
type: string
- location: *436
+ location: *433
html_url:
type: string
classifications:
@@ -61778,7 +61330,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: *437
+ items: *434
examples:
default:
value:
@@ -61817,7 +61369,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -61851,25 +61403,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *327
- - *328
- - *413
- - *414
+ - *324
+ - *325
+ - *410
+ - *411
- *19
- *17
- - *432
+ - *429
- 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: *415
+ schema: *412
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &438
+ schema: &435
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -61890,23 +61442,23 @@ paths:
application/json:
schema:
type: array
- items: &439
+ items: &436
type: object
properties:
- ref: *415
- commit_sha: &447
+ ref: *412
+ commit_sha: &444
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: *433
+ analysis_key: *430
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *435
+ category: *432
error:
type: string
example: error reading field xyz
@@ -61930,8 +61482,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *438
- tool: *422
+ sarif_id: *435
+ tool: *419
deletable:
type: boolean
warning:
@@ -61992,7 +61544,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -62028,8 +61580,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:
- - *327
- - *328
+ - *324
+ - *325
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -62042,7 +61594,7 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
response:
summary: application/json response
@@ -62096,7 +61648,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *424
+ '403': *421
'404': *6
'422':
description: Response if analysis could not be processed
@@ -62183,8 +61735,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:
- - *327
- - *328
+ - *324
+ - *325
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -62237,7 +61789,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': *430
+ '403': *427
'404': *6
'503': *113
x-github:
@@ -62259,8 +61811,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -62268,7 +61820,7 @@ paths:
application/json:
schema:
type: array
- items: &440
+ items: &437
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -62379,7 +61931,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': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -62408,8 +61960,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: language
in: path
description: The language of the CodeQL database.
@@ -62421,7 +61973,7 @@ paths:
description: Response
content:
application/json:
- schema: *440
+ schema: *437
examples:
default:
value:
@@ -62453,9 +62005,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': &476
+ '302': &473
description: Found
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -62477,8 +62029,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: language
in: path
description: The language of the CodeQL database.
@@ -62488,7 +62040,7 @@ paths:
responses:
'204':
description: Response
- '403': *430
+ '403': *427
'404': *6
'503': *113
x-github:
@@ -62516,8 +62068,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -62526,7 +62078,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &441
+ language: &438
type: string
description: The language targeted by the CodeQL query
enum:
@@ -62606,7 +62158,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &445
+ schema: &442
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -62616,7 +62168,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *58
actor: *4
- query_language: *441
+ query_language: *438
query_pack_url:
type: string
description: The download url for the query pack.
@@ -62663,7 +62215,7 @@ paths:
items:
type: object
properties:
- repository: &442
+ repository: &439
title: Repository Identifier
description: Repository Identifier
type: object
@@ -62699,7 +62251,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &446
+ analysis_status: &443
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -62731,7 +62283,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &443
+ access_mismatch_repos: &440
type: object
properties:
repository_count:
@@ -62745,7 +62297,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: *442
+ items: *439
required:
- repository_count
- repositories
@@ -62767,8 +62319,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *443
- over_limit_repos: *443
+ no_codeql_db_repos: *440
+ over_limit_repos: *440
required:
- access_mismatch_repos
- not_found_repos
@@ -62784,7 +62336,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &444
+ value: &441
summary: Default response
value:
id: 1
@@ -62930,10 +62482,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *444
+ value: *441
repository_lists:
summary: Response for a successful variant analysis submission
- value: *444
+ value: *441
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -62961,8 +62513,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:
- - *327
- - *328
+ - *324
+ - *325
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -62974,9 +62526,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *442
examples:
- default: *444
+ default: *441
'404': *6
'503': *113
x-github:
@@ -62999,7 +62551,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:
- - *327
+ - *324
- name: repo
in: path
description: The name of the controller repository.
@@ -63034,7 +62586,7 @@ paths:
type: object
properties:
repository: *58
- analysis_status: *446
+ analysis_status: *443
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -63159,8 +62711,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -63245,7 +62797,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -63266,8 +62818,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -63359,7 +62911,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *430
+ '403': *427
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -63430,8 +62982,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -63439,7 +62991,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *447
+ commit_sha: *444
ref:
type: string
description: |-
@@ -63497,7 +63049,7 @@ paths:
schema:
type: object
properties:
- id: *438
+ id: *435
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -63511,7 +63063,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': *430
+ '403': *427
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -63534,8 +63086,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -63581,7 +63133,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': *424
+ '403': *421
'404':
description: Not Found if the sarif id does not match any upload
'503': *113
@@ -63606,8 +63158,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -63688,8 +63240,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-codeowners-errors
parameters:
- - *327
- - *328
+ - *324
+ - *325
- 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
@@ -63809,8 +63361,8 @@ paths:
parameters:
- *17
- *19
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -64124,8 +63676,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -64190,7 +63742,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -64198,7 +63750,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'400': *14
'401': *25
'403': *29
@@ -64227,8 +63779,8 @@ paths:
parameters:
- *17
- *19
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -64292,8 +63844,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -64328,14 +63880,14 @@ paths:
type: integer
machines:
type: array
- items: &670
+ items: &665
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *449
- required: *450
+ properties: *446
+ required: *447
examples:
- default: &671
+ default: &666
value:
total_count: 2
machines:
@@ -64375,8 +63927,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -64460,8 +64012,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:
- - *327
- - *328
+ - *324
+ - *325
- 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
@@ -64527,8 +64079,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -64546,7 +64098,7 @@ paths:
type: integer
secrets:
type: array
- items: &454
+ items: &451
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -64566,7 +64118,7 @@ paths:
- created_at
- updated_at
examples:
- default: *451
+ default: *448
headers:
Link: *59
x-github:
@@ -64589,16 +64141,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *452
+ schema: *449
examples:
- default: *453
+ default: *450
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -64618,17 +64170,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'200':
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: *455
+ default: *452
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -64648,8 +64200,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
requestBody:
required: true
@@ -64702,8 +64254,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'204':
@@ -64732,8 +64284,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -64775,7 +64327,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &456
+ properties: &453
login:
type: string
example: octocat
@@ -64868,7 +64420,7 @@ paths:
user_view_type:
type: string
example: public
- required: &457
+ required: &454
- avatar_url
- events_url
- followers_url
@@ -64942,8 +64494,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *64
responses:
'204':
@@ -64990,8 +64542,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *64
requestBody:
required: false
@@ -65018,7 +64570,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &526
+ schema: &523
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -65247,8 +64799,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *64
responses:
'204':
@@ -65280,8 +64832,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *64
responses:
'200':
@@ -65302,8 +64854,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *456
- required: *457
+ properties: *453
+ required: *454
nullable: true
required:
- permission
@@ -65358,8 +64910,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -65369,7 +64921,7 @@ paths:
application/json:
schema:
type: array
- items: &458
+ items: &455
title: Commit Comment
description: Commit Comment
type: object
@@ -65427,7 +64979,7 @@ paths:
- created_at
- updated_at
examples:
- default: &463
+ default: &460
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -65486,17 +65038,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#get-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'200':
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- default: &464
+ default: &461
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -65553,8 +65105,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#update-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -65577,7 +65129,7 @@ paths:
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
default:
value:
@@ -65628,8 +65180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'204':
@@ -65651,8 +65203,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -65679,7 +65231,7 @@ paths:
application/json:
schema:
type: array
- items: &459
+ items: &456
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -65722,7 +65274,7 @@ paths:
- content
- created_at
examples:
- default: &530
+ default: &527
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -65767,8 +65319,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -65801,9 +65353,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: &460
+ default: &457
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -65832,9 +65384,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -65856,10 +65408,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- - &531
+ - &528
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -65914,8 +65466,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-commits
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -65971,9 +65523,9 @@ paths:
application/json:
schema:
type: array
- items: *461
+ items: *458
examples:
- default: &580
+ default: &577
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -66067,9 +65619,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *327
- - *328
- - &462
+ - *324
+ - *325
+ - &459
name: commit_sha
description: The SHA of the commit.
in: path
@@ -66141,9 +65693,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments
parameters:
- - *327
- - *328
- - *462
+ - *324
+ - *325
+ - *459
- *17
- *19
responses:
@@ -66153,9 +65705,9 @@ paths:
application/json:
schema:
type: array
- items: *458
+ items: *455
examples:
- default: *463
+ default: *460
headers:
Link: *59
x-github:
@@ -66183,9 +65735,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#create-a-commit-comment
parameters:
- - *327
- - *328
- - *462
+ - *324
+ - *325
+ - *459
requestBody:
required: true
content:
@@ -66220,9 +65772,9 @@ paths:
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- default: *464
+ default: *461
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -66250,9 +65802,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *327
- - *328
- - *462
+ - *324
+ - *325
+ - *459
- *17
- *19
responses:
@@ -66262,9 +65814,9 @@ paths:
application/json:
schema:
type: array
- items: *465
+ items: *462
examples:
- default: &572
+ default: &569
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -66801,11 +66353,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#get-a-commit
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *19
- *17
- - &466
+ - &463
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)"
@@ -66820,9 +66372,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: &557
+ default: &554
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -66935,11 +66487,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *327
- - *328
- - *466
- - *467
- - *468
+ - *324
+ - *325
+ - *463
+ - *464
+ - *465
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -66973,9 +66525,9 @@ paths:
type: integer
check_runs:
type: array
- items: *405
+ items: *402
examples:
- default: *469
+ default: *466
headers:
Link: *59
x-github:
@@ -67000,9 +66552,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *327
- - *328
- - *466
+ - *324
+ - *325
+ - *463
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -67010,7 +66562,7 @@ paths:
schema:
type: integer
example: 1
- - *467
+ - *464
- *17
- *19
responses:
@@ -67028,7 +66580,7 @@ paths:
type: integer
check_suites:
type: array
- items: *410
+ items: *407
examples:
default:
value:
@@ -67228,9 +66780,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *327
- - *328
- - *466
+ - *324
+ - *325
+ - *463
- *17
- *19
responses:
@@ -67428,9 +66980,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *327
- - *328
- - *466
+ - *324
+ - *325
+ - *463
- *17
- *19
responses:
@@ -67440,7 +66992,7 @@ paths:
application/json:
schema:
type: array
- items: &645
+ items: &642
title: Status
description: The status of a commit.
type: object
@@ -67521,7 +67073,7 @@ paths:
site_admin: false
headers:
Link: *59
- '301': *331
+ '301': *328
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67549,8 +67101,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -67579,20 +67131,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *470
- required: *471
+ properties: *467
+ required: *468
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &472
+ properties: &469
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &473
+ required: &470
- url
- html_url
nullable: true
@@ -67606,26 +67158,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *472
- required: *473
+ properties: *469
+ required: *470
nullable: true
readme:
title: Community Health File
type: object
- properties: *472
- required: *473
+ properties: *469
+ required: *470
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *472
- required: *473
+ properties: *469
+ required: *470
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *472
- required: *473
+ properties: *469
+ required: *470
nullable: true
required:
- code_of_conduct
@@ -67752,8 +67304,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#compare-two-commits
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *19
- *17
- name: basehead
@@ -67796,8 +67348,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *461
- merge_base_commit: *461
+ base_commit: *458
+ merge_base_commit: *458
status:
type: string
enum:
@@ -67817,10 +67369,10 @@ paths:
example: 6
commits:
type: array
- items: *461
+ items: *458
files:
type: array
- items: *474
+ items: *471
required:
- url
- html_url
@@ -68106,8 +67658,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-repository-content
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: path
description: path parameter
in: path
@@ -68250,7 +67802,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &475
+ response-if-content-is-a-file: &472
summary: Response if content is a file
value:
type: file
@@ -68382,7 +67934,7 @@ paths:
- size
- type
- url
- - &585
+ - &582
title: Content File
description: Content File
type: object
@@ -68583,7 +68135,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *475
+ response-if-content-is-a-file: *472
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -68652,7 +68204,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *476
+ '302': *473
'304': *37
x-github:
githubCloudOnly: false
@@ -68675,8 +68227,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: path
description: path parameter
in: path
@@ -68769,7 +68321,7 @@ paths:
description: Response
content:
application/json:
- schema: &477
+ schema: &474
title: File Commit
description: File Commit
type: object
@@ -68921,7 +68473,7 @@ paths:
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
example-for-creating-a-file:
value:
@@ -68975,7 +68527,7 @@ paths:
schema:
oneOf:
- *3
- - &508
+ - &505
description: Repository rule violation was detected
type: object
properties:
@@ -68996,7 +68548,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &637
+ placeholder_id: &634
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -69028,8 +68580,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#delete-a-file
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: path
description: path parameter
in: path
@@ -69090,7 +68642,7 @@ paths:
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
default:
value:
@@ -69145,8 +68697,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-contributors
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -69269,8 +68821,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *190
- *191
- *192
@@ -69282,7 +68834,7 @@ paths:
schema:
type: string
- *194
- - *478
+ - *475
- *195
- *196
- *53
@@ -69303,7 +68855,7 @@ paths:
application/json:
schema:
type: array
- items: &482
+ items: &479
type: object
description: A Dependabot alert.
properties:
@@ -69349,7 +68901,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *479
+ security_advisory: *476
security_vulnerability: *57
url: *173
html_url: *174
@@ -69380,8 +68932,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *175
- auto_dismissed_at: *480
- dismissal_request: *481
+ auto_dismissed_at: *477
+ dismissal_request: *478
required:
- number
- state
@@ -69611,9 +69163,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *327
- - *328
- - &483
+ - *324
+ - *325
+ - &480
name: alert_number
in: path
description: |-
@@ -69628,7 +69180,7 @@ paths:
description: Response
content:
application/json:
- schema: *482
+ schema: *479
examples:
default:
value:
@@ -69741,9 +69293,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *327
- - *328
- - *483
+ - *324
+ - *325
+ - *480
requestBody:
required: true
content:
@@ -69788,7 +69340,7 @@ paths:
description: Response
content:
application/json:
- schema: *482
+ schema: *479
examples:
default:
value:
@@ -69917,8 +69469,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -69936,7 +69488,7 @@ paths:
type: integer
secrets:
type: array
- items: &486
+ items: &483
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -69989,16 +69541,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *484
+ schema: *481
examples:
- default: *485
+ default: *482
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -70018,15 +69570,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'200':
description: Response
content:
application/json:
- schema: *486
+ schema: *483
examples:
default:
value:
@@ -70052,8 +69604,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
requestBody:
required: true
@@ -70106,8 +69658,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'204':
@@ -70130,8 +69682,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:
- - *327
- - *328
+ - *324
+ - *325
- 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
@@ -70291,8 +69843,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -70531,8 +70083,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -70607,7 +70159,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &487
+ metadata: &484
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -70640,7 +70192,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *487
+ metadata: *484
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -70653,7 +70205,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *487
+ metadata: *484
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -70782,8 +70334,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#list-deployments
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -70823,9 +70375,9 @@ paths:
application/json:
schema:
type: array
- items: *488
+ items: *485
examples:
- default: *489
+ default: *486
headers:
Link: *59
x-github:
@@ -70891,8 +70443,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#create-a-deployment
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -70973,7 +70525,7 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
simple-example:
summary: Simple example
@@ -71046,9 +70598,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#get-a-deployment
parameters:
- - *327
- - *328
- - &490
+ - *324
+ - *325
+ - &487
name: deployment_id
description: deployment_id parameter
in: path
@@ -71060,7 +70612,7 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
default:
value:
@@ -71125,9 +70677,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment
parameters:
- - *327
- - *328
- - *490
+ - *324
+ - *325
+ - *487
responses:
'204':
description: Response
@@ -71149,9 +70701,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *327
- - *328
- - *490
+ - *324
+ - *325
+ - *487
- *17
- *19
responses:
@@ -71161,7 +70713,7 @@ paths:
application/json:
schema:
type: array
- items: &491
+ items: &488
title: Deployment Status
description: The status of a deployment.
type: object
@@ -71322,9 +70874,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *327
- - *328
- - *490
+ - *324
+ - *325
+ - *487
requestBody:
required: true
content:
@@ -71399,9 +70951,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: &492
+ default: &489
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -71457,9 +71009,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *327
- - *328
- - *490
+ - *324
+ - *325
+ - *487
- name: status_id
in: path
required: true
@@ -71470,9 +71022,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: *492
+ default: *489
'404': *6
x-github:
githubCloudOnly: false
@@ -71497,8 +71049,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -71555,8 +71107,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#list-environments
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -71573,7 +71125,7 @@ paths:
type: integer
environments:
type: array
- items: &494
+ items: &491
title: Environment
description: Details of a deployment environment
type: object
@@ -71625,7 +71177,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &496
+ wait_timer: &493
type: integer
example: 30
description: The amount of time to delay a job after
@@ -71662,7 +71214,7 @@ paths:
items:
type: object
properties:
- type: *493
+ type: *490
reviewer:
anyOf:
- *4
@@ -71686,7 +71238,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &497
+ deployment_branch_policy: &494
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -71802,9 +71354,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#get-an-environment
parameters:
- - *327
- - *328
- - &495
+ - *324
+ - *325
+ - &492
name: environment_name
in: path
required: true
@@ -71817,9 +71369,9 @@ paths:
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: &498
+ default: &495
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -71903,9 +71455,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
requestBody:
required: false
content:
@@ -71914,7 +71466,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *496
+ wait_timer: *493
prevent_self_review:
type: boolean
example: false
@@ -71931,13 +71483,13 @@ paths:
items:
type: object
properties:
- type: *493
+ type: *490
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *497
+ deployment_branch_policy: *494
additionalProperties: false
examples:
default:
@@ -71957,9 +71509,9 @@ paths:
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: *498
+ default: *495
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -71983,9 +71535,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#delete-an-environment
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
responses:
'204':
description: Default response
@@ -72010,9 +71562,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *17
- *19
responses:
@@ -72030,7 +71582,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &499
+ items: &496
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -72087,9 +71639,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
requestBody:
required: true
content:
@@ -72135,9 +71687,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- example-wildcard: &500
+ example-wildcard: &497
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -72179,10 +71731,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *327
- - *328
- - *495
- - &501
+ - *324
+ - *325
+ - *492
+ - &498
name: branch_policy_id
in: path
required: true
@@ -72194,9 +71746,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72215,10 +71767,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *327
- - *328
- - *495
- - *501
+ - *324
+ - *325
+ - *492
+ - *498
requestBody:
required: true
content:
@@ -72246,9 +71798,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72267,10 +71819,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *327
- - *328
- - *495
- - *501
+ - *324
+ - *325
+ - *492
+ - *498
responses:
'204':
description: Response
@@ -72295,9 +71847,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *495
- - *328
- - *327
+ - *492
+ - *325
+ - *324
responses:
'200':
description: List of deployment protection rules
@@ -72313,7 +71865,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &502
+ items: &499
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -72332,7 +71884,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &503
+ app: &500
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -72431,9 +71983,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:
- - *495
- - *328
- - *327
+ - *492
+ - *325
+ - *324
requestBody:
content:
application/json:
@@ -72454,9 +72006,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *502
+ schema: *499
examples:
- default: &504
+ default: &501
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -72491,9 +72043,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:
- - *495
- - *328
- - *327
+ - *492
+ - *325
+ - *324
- *19
- *17
responses:
@@ -72512,7 +72064,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *503
+ items: *500
examples:
default:
value:
@@ -72547,10 +72099,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *327
- - *328
- - *495
- - &505
+ - *324
+ - *325
+ - *492
+ - &502
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -72562,9 +72114,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
- default: *504
+ default: *501
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72585,10 +72137,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *495
- - *328
- - *327
- - *505
+ - *492
+ - *325
+ - *324
+ - *502
responses:
'204':
description: Response
@@ -72614,9 +72166,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-environment-secrets
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *17
- *19
responses:
@@ -72634,9 +72186,9 @@ paths:
type: integer
secrets:
type: array
- items: *372
+ items: *369
examples:
- default: *373
+ default: *370
headers:
Link: *59
x-github:
@@ -72661,17 +72213,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
responses:
'200':
description: Response
content:
application/json:
- schema: *374
+ schema: *371
examples:
- default: *375
+ default: *372
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72693,18 +72245,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *160
responses:
'200':
description: Response
content:
application/json:
- schema: *372
+ schema: *369
examples:
- default: *506
+ default: *503
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72726,9 +72278,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *160
requestBody:
required: true
@@ -72786,9 +72338,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *160
responses:
'204':
@@ -72814,10 +72366,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-environment-variables
parameters:
- - *327
- - *328
- - *495
- - *343
+ - *324
+ - *325
+ - *492
+ - *340
- *19
responses:
'200':
@@ -72834,9 +72386,9 @@ paths:
type: integer
variables:
type: array
- items: *376
+ items: *373
examples:
- default: *377
+ default: *374
headers:
Link: *59
x-github:
@@ -72859,9 +72411,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-an-environment-variable
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
requestBody:
required: true
content:
@@ -72913,18 +72465,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-an-environment-variable
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *163
responses:
'200':
description: Response
content:
application/json:
- schema: *376
+ schema: *373
examples:
- default: *507
+ default: *504
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72945,10 +72497,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-an-environment-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
- - *495
+ - *492
requestBody:
required: true
content:
@@ -72990,10 +72542,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
- - *495
+ - *492
responses:
'204':
description: Response
@@ -73015,8 +72567,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-repository-events
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -73084,8 +72636,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#list-forks
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -73244,8 +72796,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#create-a-fork
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -73277,9 +72829,9 @@ paths:
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
+ default: *329
'400': *14
'422': *15
'403': *29
@@ -73300,8 +72852,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#create-a-blob
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -73361,7 +72913,7 @@ paths:
schema:
oneOf:
- *121
- - *508
+ - *505
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73386,8 +72938,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#get-a-blob
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: file_sha
in: path
required: true
@@ -73486,8 +73038,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#create-a-commit
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -73596,7 +73148,7 @@ paths:
description: Response
content:
application/json:
- schema: &509
+ schema: &506
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -73810,15 +73362,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#get-a-commit-object
parameters:
- - *327
- - *328
- - *462
+ - *324
+ - *325
+ - *459
responses:
'200':
description: Response
content:
application/json:
- schema: *509
+ schema: *506
examples:
default:
value:
@@ -73874,9 +73426,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#list-matching-references
parameters:
- - *327
- - *328
- - &510
+ - *324
+ - *325
+ - &507
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.
@@ -73893,7 +73445,7 @@ paths:
application/json:
schema:
type: array
- items: &511
+ items: &508
title: Git Reference
description: Git references within a repository
type: object
@@ -73968,17 +73520,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#get-a-reference
parameters:
- - *327
- - *328
- - *510
+ - *324
+ - *325
+ - *507
responses:
'200':
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: &512
+ default: &509
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -74007,8 +73559,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#create-a-reference
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -74037,9 +73589,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: *512
+ default: *509
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -74065,9 +73617,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#update-a-reference
parameters:
- - *327
- - *328
- - *510
+ - *324
+ - *325
+ - *507
requestBody:
required: true
content:
@@ -74096,9 +73648,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: *512
+ default: *509
'422': *15
'409': *52
x-github:
@@ -74116,9 +73668,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#delete-a-reference
parameters:
- - *327
- - *328
- - *510
+ - *324
+ - *325
+ - *507
responses:
'204':
description: Response
@@ -74173,8 +73725,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#create-a-tag-object
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -74241,7 +73793,7 @@ paths:
description: Response
content:
application/json:
- schema: &514
+ schema: &511
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -74292,7 +73844,7 @@ paths:
- sha
- type
- url
- verification: *513
+ verification: *510
required:
- sha
- url
@@ -74302,7 +73854,7 @@ paths:
- tag
- message
examples:
- default: &515
+ default: &512
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -74375,8 +73927,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#get-a-tag
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: tag_sha
in: path
required: true
@@ -74387,9 +73939,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *515
+ default: *512
'404': *6
'409': *52
x-github:
@@ -74413,8 +73965,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#create-a-tree
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -74487,7 +74039,7 @@ paths:
description: Response
content:
application/json:
- schema: &516
+ schema: &513
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -74583,8 +74135,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#get-a-tree
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -74607,7 +74159,7 @@ paths:
description: Response
content:
application/json:
- schema: *516
+ schema: *513
examples:
default-response:
summary: Default response
@@ -74666,8 +74218,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -74677,7 +74229,7 @@ paths:
application/json:
schema:
type: array
- items: &517
+ items: &514
title: Webhook
description: Webhooks for repositories.
type: object
@@ -74731,7 +74283,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &759
+ last_response: &754
title: Hook Response
type: object
properties:
@@ -74805,8 +74357,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -74858,9 +74410,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: &518
+ default: &515
value:
type: Repository
id: 12345678
@@ -74908,17 +74460,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
'404': *6
x-github:
githubCloudOnly: false
@@ -74938,8 +74490,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
requestBody:
required: true
@@ -74985,9 +74537,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
'422': *15
'404': *6
x-github:
@@ -75008,8 +74560,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'204':
@@ -75034,8 +74586,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'200':
@@ -75063,8 +74615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
requestBody:
required: false
@@ -75109,8 +74661,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
- *17
- *205
@@ -75142,8 +74694,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
- *16
responses:
@@ -75172,8 +74724,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
- *16
responses:
@@ -75197,8 +74749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'204':
@@ -75224,8 +74776,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'204':
@@ -75249,8 +74801,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response if immutable releases are enabled
@@ -75296,8 +74848,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-immutable-releases
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204': *183
'409': *52
@@ -75317,8 +74869,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-immutable-releases
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204': *183
'409': *52
@@ -75375,14 +74927,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &519
+ schema: &516
title: Import
description: A repository import from an external source.
type: object
@@ -75481,7 +75033,7 @@ paths:
- html_url
- authors_url
examples:
- default: &522
+ default: &519
value:
vcs: subversion
use_lfs: true
@@ -75497,7 +75049,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': &520
+ '503': &517
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -75526,8 +75078,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#start-an-import
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -75575,7 +75127,7 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
default:
value:
@@ -75600,7 +75152,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75628,8 +75180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-an-import
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -75678,7 +75230,7 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
example-1:
summary: Example 1
@@ -75726,7 +75278,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': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75749,12 +75301,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75780,9 +75332,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors
parameters:
- - *327
- - *328
- - &692
+ - *324
+ - *325
+ - &687
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -75796,7 +75348,7 @@ paths:
application/json:
schema:
type: array
- items: &521
+ items: &518
title: Porter Author
description: Porter Author
type: object
@@ -75850,7 +75402,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': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75875,8 +75427,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: author_id
in: path
required: true
@@ -75906,7 +75458,7 @@ paths:
description: Response
content:
application/json:
- schema: *521
+ schema: *518
examples:
default:
value:
@@ -75919,7 +75471,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75943,8 +75495,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-large-files
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -75985,7 +75537,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76013,8 +75565,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -76041,11 +75593,11 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: *522
+ default: *519
'422': *15
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76068,8 +75620,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -76077,8 +75629,8 @@ paths:
application/json:
schema: *22
examples:
- default: *523
- '301': *331
+ default: *520
+ '301': *328
'404': *6
x-github:
githubCloudOnly: false
@@ -76098,8 +75650,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -76112,7 +75664,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &525
+ default: &522
value:
limit: collaborators_only
origin: repository
@@ -76137,13 +75689,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *524
+ schema: *521
examples:
default:
summary: Example request body
@@ -76157,7 +75709,7 @@ paths:
application/json:
schema: *222
examples:
- default: *525
+ default: *522
'409':
description: Response
x-github:
@@ -76179,8 +75731,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -76203,8 +75755,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -76214,9 +75766,9 @@ paths:
application/json:
schema:
type: array
- items: *526
+ items: *523
examples:
- default: &685
+ default: &680
value:
- id: 1
repository:
@@ -76347,8 +75899,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *226
requestBody:
required: false
@@ -76378,7 +75930,7 @@ paths:
description: Response
content:
application/json:
- schema: *526
+ schema: *523
examples:
default:
value:
@@ -76509,8 +76061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *226
responses:
'204':
@@ -76542,8 +76094,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-repository-issues
parameters:
- - *327
- - *328
+ - *324
+ - *325
- 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
@@ -76616,7 +76168,7 @@ paths:
type: array
items: *75
examples:
- default: &538
+ default: &535
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -76764,7 +76316,7 @@ paths:
state_reason: completed
headers:
Link: *59
- '301': *331
+ '301': *328
'422': *15
'404': *6
x-github:
@@ -76793,8 +76345,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#create-an-issue
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -76878,7 +76430,7 @@ paths:
application/json:
schema: *75
examples:
- default: &535
+ default: &532
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -77034,7 +76586,7 @@ paths:
'422': *15
'503': *113
'404': *6
- '410': *527
+ '410': *524
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -77062,8 +76614,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *99
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -77084,9 +76636,9 @@ paths:
application/json:
schema:
type: array
- items: *528
+ items: *525
examples:
- default: &537
+ default: &534
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -77144,17 +76696,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#get-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'200':
description: Response
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: &529
+ default: &526
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -77208,8 +76760,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#update-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -77232,9 +76784,9 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: *529
+ default: *526
'422': *15
x-github:
githubCloudOnly: false
@@ -77252,8 +76804,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'204':
@@ -77274,8 +76826,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -77302,9 +76854,9 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *530
+ default: *527
headers:
Link: *59
'404': *6
@@ -77325,8 +76877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -77359,16 +76911,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'201':
description: Reaction created
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -77390,10 +76942,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- - *531
+ - *528
responses:
'204':
description: Response
@@ -77413,8 +76965,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -77424,7 +76976,7 @@ paths:
application/json:
schema:
type: array
- items: &534
+ items: &531
title: Issue Event
description: Issue Event
type: object
@@ -77467,8 +77019,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *532
- required: *533
+ properties: *529
+ required: *530
nullable: true
label:
title: Issue Event Label
@@ -77775,8 +77327,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#get-an-issue-event
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: event_id
in: path
required: true
@@ -77787,7 +77339,7 @@ paths:
description: Response
content:
application/json:
- schema: *534
+ schema: *531
examples:
default:
value:
@@ -77979,7 +77531,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *527
+ '410': *524
'403': *29
x-github:
githubCloudOnly: false
@@ -78013,9 +77565,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#get-an-issue
parameters:
- - *327
- - *328
- - &536
+ - *324
+ - *325
+ - &533
name: issue_number
description: The number that identifies the issue.
in: path
@@ -78029,10 +77581,10 @@ paths:
application/json:
schema: *75
examples:
- default: *535
- '301': *331
+ default: *532
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
'304': *37
x-github:
githubCloudOnly: false
@@ -78057,9 +77609,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#update-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -78165,13 +77717,13 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
'422': *15
'503': *113
'403': *29
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78189,9 +77741,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -78219,7 +77771,7 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78235,9 +77787,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
content:
application/json:
@@ -78264,7 +77816,7 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78286,9 +77838,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- name: assignee
in: path
required: true
@@ -78328,9 +77880,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *82
- *17
- *19
@@ -78341,13 +77893,13 @@ paths:
application/json:
schema:
type: array
- items: *528
+ items: *525
examples:
- default: *537
+ default: *534
headers:
Link: *59
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78376,9 +77928,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#create-an-issue-comment
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -78400,16 +77952,16 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: *529
+ default: *526
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *527
+ '410': *524
'422': *15
'404': *6
x-github:
@@ -78437,9 +77989,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -78451,12 +78003,12 @@ paths:
type: array
items: *75
examples:
- default: *538
+ default: *535
headers:
Link: *59
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78484,9 +78036,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -78510,15 +78062,15 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *331
+ '301': *328
'403': *29
- '410': *527
+ '410': *524
'422': *15
'404': *6
x-github:
@@ -78549,9 +78101,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -78565,13 +78117,13 @@ paths:
application/json:
schema: *75
examples:
- default: *535
- '301': *331
+ default: *532
+ '301': *328
'400': *14
'401': *25
'403': *29
'404': *6
- '410': *527
+ '410': *524
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -78597,9 +78149,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -78611,12 +78163,12 @@ paths:
type: array
items: *75
examples:
- default: *538
+ default: *535
headers:
Link: *59
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78633,9 +78185,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -78649,7 +78201,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &540
+ - &537
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -78703,7 +78255,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &541
+ - &538
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -78839,7 +78391,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &542
+ - &539
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -78890,7 +78442,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &543
+ - &540
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -78941,7 +78493,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &544
+ - &541
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -78995,7 +78547,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &545
+ - &542
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -79042,7 +78594,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &546
+ - &543
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -79089,7 +78641,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &547
+ - &544
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -79149,7 +78701,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &548
+ - &545
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -79197,7 +78749,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &549
+ - &546
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -79263,7 +78815,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &550
+ - &547
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -79329,7 +78881,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &551
+ - &548
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -79395,7 +78947,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &552
+ - &549
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -79486,7 +79038,7 @@ paths:
color: red
headers:
Link: *59
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79503,9 +79055,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -79517,7 +79069,7 @@ paths:
type: array
items: *74
examples:
- default: &539
+ default: &536
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -79535,9 +79087,9 @@ paths:
default: false
headers:
Link: *59
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79554,9 +79106,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -79617,10 +79169,10 @@ paths:
type: array
items: *74
examples:
- default: *539
- '301': *331
+ default: *536
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
'422': *15
x-github:
githubCloudOnly: false
@@ -79637,9 +79189,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -79701,10 +79253,10 @@ paths:
type: array
items: *74
examples:
- default: *539
- '301': *331
+ default: *536
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
'422': *15
x-github:
githubCloudOnly: false
@@ -79721,15 +79273,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
responses:
'204':
description: Response
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79748,9 +79300,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- name: name
in: path
required: true
@@ -79774,9 +79326,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79796,9 +79348,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#lock-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -79826,7 +79378,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *527
+ '410': *524
'404': *6
'422': *15
x-github:
@@ -79844,9 +79396,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#unlock-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
responses:
'204':
description: Response
@@ -79876,9 +79428,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
responses:
'200':
description: Response
@@ -79886,10 +79438,10 @@ paths:
application/json:
schema: *75
examples:
- default: *535
- '301': *331
+ default: *532
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79906,9 +79458,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -79934,13 +79486,13 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *530
+ default: *527
headers:
Link: *59
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79958,9 +79510,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -79992,16 +79544,16 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'201':
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -80023,10 +79575,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *327
- - *328
- - *536
- - *531
+ - *324
+ - *325
+ - *533
+ - *528
responses:
'204':
description: Response
@@ -80055,9 +79607,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -80081,7 +79633,7 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -80114,9 +79666,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -80128,11 +79680,11 @@ paths:
type: array
items: *75
examples:
- default: *538
+ default: *535
headers:
Link: *59
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80160,9 +79712,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -80191,14 +79743,14 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *527
+ '410': *524
'422': *15
'404': *6
x-github:
@@ -80218,9 +79770,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -80253,7 +79805,7 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
'403': *29
'404': *6
'422': *7
@@ -80275,9 +79827,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -80292,6 +79844,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *537
+ - *538
+ - *539
- *540
- *541
- *542
@@ -80302,9 +79857,6 @@ paths:
- *547
- *548
- *549
- - *550
- - *551
- - *552
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -80613,7 +80165,7 @@ paths:
type: string
comments:
type: array
- items: &574
+ items: &571
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -80828,7 +80380,7 @@ paths:
type: string
comments:
type: array
- items: *458
+ items: *455
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -81117,7 +80669,7 @@ paths:
headers:
Link: *59
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81134,8 +80686,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -81145,7 +80697,7 @@ paths:
application/json:
schema:
type: array
- items: &553
+ items: &550
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -81211,8 +80763,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -81248,9 +80800,9 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
- default: &554
+ default: &551
value:
id: 1
key: ssh-rsa AAA...
@@ -81284,9 +80836,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *327
- - *328
- - &555
+ - *324
+ - *325
+ - &552
name: key_id
description: The unique identifier of the key.
in: path
@@ -81298,9 +80850,9 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
- default: *554
+ default: *551
'404': *6
x-github:
githubCloudOnly: false
@@ -81318,9 +80870,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *327
- - *328
- - *555
+ - *324
+ - *325
+ - *552
responses:
'204':
description: Response
@@ -81340,8 +80892,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -81353,7 +80905,7 @@ paths:
type: array
items: *74
examples:
- default: *539
+ default: *536
headers:
Link: *59
'404': *6
@@ -81374,8 +80926,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#create-a-label
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -81413,7 +80965,7 @@ paths:
application/json:
schema: *74
examples:
- default: &556
+ default: &553
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -81445,8 +80997,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#get-a-label
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: name
in: path
required: true
@@ -81459,7 +81011,7 @@ paths:
application/json:
schema: *74
examples:
- default: *556
+ default: *553
'404': *6
x-github:
githubCloudOnly: false
@@ -81476,8 +81028,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#update-a-label
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: name
in: path
required: true
@@ -81542,8 +81094,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#delete-a-label
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: name
in: path
required: true
@@ -81569,8 +81121,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-languages
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -81609,9 +81161,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *327
- - *328
- - *431
+ - *324
+ - *325
+ - *428
responses:
'200':
description: Response
@@ -81756,8 +81308,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -81822,8 +81374,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#merge-a-branch
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -81857,9 +81409,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: *557
+ default: *554
'204':
description: Response when already merged
'404':
@@ -81884,8 +81436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#list-milestones
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -81926,7 +81478,7 @@ paths:
application/json:
schema:
type: array
- items: &558
+ items: &555
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -81987,8 +81539,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#create-a-milestone
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -82028,9 +81580,9 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: &559
+ default: &556
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -82089,9 +81641,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#get-a-milestone
parameters:
- - *327
- - *328
- - &560
+ - *324
+ - *325
+ - &557
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -82103,9 +81655,9 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: *559
+ default: *556
'404': *6
x-github:
githubCloudOnly: false
@@ -82122,9 +81674,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#update-a-milestone
parameters:
- - *327
- - *328
- - *560
+ - *324
+ - *325
+ - *557
requestBody:
required: false
content:
@@ -82162,9 +81714,9 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: *559
+ default: *556
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82180,9 +81732,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#delete-a-milestone
parameters:
- - *327
- - *328
- - *560
+ - *324
+ - *325
+ - *557
responses:
'204':
description: Response
@@ -82203,9 +81755,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *327
- - *328
- - *560
+ - *324
+ - *325
+ - *557
- *17
- *19
responses:
@@ -82217,7 +81769,7 @@ paths:
type: array
items: *74
examples:
- default: *539
+ default: *536
headers:
Link: *59
x-github:
@@ -82236,12 +81788,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *327
- - *328
- - *561
- - *562
+ - *324
+ - *325
+ - *558
+ - *559
- *82
- - *563
+ - *560
- *17
- *19
responses:
@@ -82253,7 +81805,7 @@ paths:
type: array
items: *102
examples:
- default: *564
+ default: *561
headers:
Link: *59
x-github:
@@ -82277,8 +81829,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -82336,14 +81888,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &565
+ schema: &562
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -82468,7 +82020,7 @@ paths:
- custom_404
- public
examples:
- default: &566
+ default: &563
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -82509,8 +82061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -82564,9 +82116,9 @@ paths:
description: Response
content:
application/json:
- schema: *565
+ schema: *562
examples:
- default: *566
+ default: *563
'422': *15
'409': *52
x-github:
@@ -82589,8 +82141,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -82689,8 +82241,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -82716,8 +82268,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -82727,7 +82279,7 @@ paths:
application/json:
schema:
type: array
- items: &567
+ items: &564
title: Page Build
description: Page Build
type: object
@@ -82821,8 +82373,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'201':
description: Response
@@ -82867,16 +82419,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-latest-pages-build
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: &568
+ default: &565
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -82924,8 +82476,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: build_id
in: path
required: true
@@ -82936,9 +82488,9 @@ paths:
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: *568
+ default: *565
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82958,8 +82510,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -83064,9 +82616,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *327
- - *328
- - &569
+ - *324
+ - *325
+ - &566
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -83124,9 +82676,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *327
- - *328
- - *569
+ - *324
+ - *325
+ - *566
responses:
'204': *183
'404': *6
@@ -83153,8 +82705,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -83412,8 +82964,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Private vulnerability reporting status
@@ -83450,8 +83002,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204': *183
'422': *14
@@ -83472,8 +83024,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204': *183
'422': *14
@@ -83495,8 +83047,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -83506,7 +83058,7 @@ paths:
type: array
items: *111
examples:
- default: *570
+ default: *567
'403': *29
'404': *6
x-github:
@@ -83528,8 +83080,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -83545,7 +83097,7 @@ paths:
required:
- properties
examples:
- default: *571
+ default: *568
responses:
'204':
description: No Content when custom property values are successfully created
@@ -83583,8 +83135,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -83644,9 +83196,9 @@ paths:
application/json:
schema:
type: array
- items: *465
+ items: *462
examples:
- default: *572
+ default: *569
headers:
Link: *59
'304': *37
@@ -83678,8 +83230,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -83744,7 +83296,7 @@ paths:
description: Response
content:
application/json:
- schema: &576
+ schema: &573
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -83958,7 +83510,7 @@ paths:
- review_comment
- self
author_association: *76
- auto_merge: *573
+ auto_merge: *570
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -84050,7 +83602,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &577
+ default: &574
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -84577,8 +84129,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sort
in: query
required: false
@@ -84607,9 +84159,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: &579
+ default: &576
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -84686,17 +84238,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'200':
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: &575
+ default: &572
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -84771,8 +84323,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -84795,9 +84347,9 @@ paths:
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84813,8 +84365,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'204':
@@ -84836,8 +84388,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -84864,9 +84416,9 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *530
+ default: *527
headers:
Link: *59
'404': *6
@@ -84887,8 +84439,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -84921,16 +84473,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'201':
description: Reaction created
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -84952,10 +84504,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- - *531
+ - *528
responses:
'204':
description: Response
@@ -84998,9 +84550,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request
parameters:
- - *327
- - *328
- - &578
+ - *324
+ - *325
+ - &575
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -85013,9 +84565,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *577
+ default: *574
'304': *37
'404': *6
'406':
@@ -85050,9 +84602,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -85094,9 +84646,9 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *577
+ default: *574
'422': *15
'403': *29
x-github:
@@ -85118,9 +84670,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: true
content:
@@ -85182,7 +84734,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -85190,7 +84742,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'401': *25
'403': *29
'404': *6
@@ -85220,9 +84772,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *99
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -85243,9 +84795,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *579
+ default: *576
headers:
Link: *59
x-github:
@@ -85278,9 +84830,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: true
content:
@@ -85385,7 +84937,7 @@ paths:
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
example-for-a-multi-line-comment:
value:
@@ -85473,9 +85025,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *91
requestBody:
required: true
@@ -85498,7 +85050,7 @@ paths:
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
default:
value:
@@ -85584,9 +85136,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *17
- *19
responses:
@@ -85596,9 +85148,9 @@ paths:
application/json:
schema:
type: array
- items: *461
+ items: *458
examples:
- default: *580
+ default: *577
headers:
Link: *59
x-github:
@@ -85628,9 +85180,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *17
- *19
responses:
@@ -85640,7 +85192,7 @@ paths:
application/json:
schema:
type: array
- items: *474
+ items: *471
examples:
default:
value:
@@ -85678,9 +85230,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
responses:
'204':
description: Response if pull request has been merged
@@ -85703,9 +85255,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -85816,9 +85368,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
responses:
'200':
description: Response
@@ -85893,9 +85445,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -85932,7 +85484,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *462
examples:
default:
value:
@@ -86468,9 +86020,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: true
content:
@@ -86504,7 +86056,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *462
examples:
default:
value:
@@ -87009,9 +86561,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *17
- *19
responses:
@@ -87021,7 +86573,7 @@ paths:
application/json:
schema:
type: array
- items: &581
+ items: &578
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -87172,9 +86724,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -87260,9 +86812,9 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
- default: &583
+ default: &580
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -87325,10 +86877,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - &582
+ - *324
+ - *325
+ - *575
+ - &579
name: review_id
description: The unique identifier of the review.
in: path
@@ -87340,9 +86892,9 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
- default: &584
+ default: &581
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -87401,10 +86953,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
requestBody:
required: true
content:
@@ -87427,7 +86979,7 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
default:
value:
@@ -87489,18 +87041,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
responses:
'200':
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
- default: *583
+ default: *580
'422': *7
'404': *6
x-github:
@@ -87527,10 +87079,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
- *17
- *19
responses:
@@ -87765,10 +87317,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
requestBody:
required: true
content:
@@ -87796,7 +87348,7 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
default:
value:
@@ -87859,10 +87411,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
requestBody:
required: true
content:
@@ -87897,9 +87449,9 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
- default: *584
+ default: *581
'404': *6
'422': *7
'403': *29
@@ -87921,9 +87473,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -87986,8 +87538,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -88000,9 +87552,9 @@ paths:
description: Response
content:
application/json:
- schema: *585
+ schema: *582
examples:
- default: &586
+ default: &583
value:
type: file
encoding: base64
@@ -88044,8 +87596,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: dir
description: The alternate path to look for a README file
in: path
@@ -88065,9 +87617,9 @@ paths:
description: Response
content:
application/json:
- schema: *585
+ schema: *582
examples:
- default: *586
+ default: *583
'404': *6
'422': *15
x-github:
@@ -88089,8 +87641,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#list-releases
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -88100,7 +87652,7 @@ paths:
application/json:
schema:
type: array
- items: *587
+ items: *584
examples:
default:
value:
@@ -88194,8 +87746,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#create-a-release
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -88271,9 +87823,9 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: &591
+ default: &588
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -88378,9 +87930,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#get-a-release-asset
parameters:
- - *327
- - *328
- - &589
+ - *324
+ - *325
+ - &586
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -88392,9 +87944,9 @@ paths:
description: Response
content:
application/json:
- schema: *588
+ schema: *585
examples:
- default: &590
+ default: &587
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1
browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip
@@ -88429,7 +87981,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *476
+ '302': *473
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88445,9 +87997,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#update-a-release-asset
parameters:
- - *327
- - *328
- - *589
+ - *324
+ - *325
+ - *586
requestBody:
required: false
content:
@@ -88475,9 +88027,9 @@ paths:
description: Response
content:
application/json:
- schema: *588
+ schema: *585
examples:
- default: *590
+ default: *587
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88493,9 +88045,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#delete-a-release-asset
parameters:
- - *327
- - *328
- - *589
+ - *324
+ - *325
+ - *586
responses:
'204':
description: Response
@@ -88519,8 +88071,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -88605,16 +88157,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-the-latest-release
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: *591
+ default: *588
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88631,8 +88183,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: tag
description: tag parameter
in: path
@@ -88645,9 +88197,9 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: *591
+ default: *588
'404': *6
x-github:
githubCloudOnly: false
@@ -88669,9 +88221,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release
parameters:
- - *327
- - *328
- - &592
+ - *324
+ - *325
+ - &589
name: release_id
description: The unique identifier of the release.
in: path
@@ -88685,9 +88237,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: *591
+ default: *588
'401':
description: Unauthorized
x-github:
@@ -88705,9 +88257,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#update-a-release
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
requestBody:
required: false
content:
@@ -88771,9 +88323,9 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: *591
+ default: *588
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -88794,9 +88346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#delete-a-release
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
responses:
'204':
description: Response
@@ -88816,9 +88368,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#list-release-assets
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
- *17
- *19
responses:
@@ -88828,7 +88380,7 @@ paths:
application/json:
schema:
type: array
- items: *588
+ items: *585
examples:
default:
value:
@@ -88909,9 +88461,9 @@ paths:
description: The URL origin (protocol + host name + port) is included in `upload_url`
returned in the response of the "Create a release" endpoint
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
- name: name
in: query
required: true
@@ -88937,7 +88489,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *588
+ schema: *585
examples:
response-for-successful-upload:
value:
@@ -88992,9 +88544,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -89018,9 +88570,9 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *530
+ default: *527
headers:
Link: *59
'404': *6
@@ -89041,9 +88593,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
requestBody:
required: true
content:
@@ -89073,16 +88625,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'201':
description: Reaction created
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -89104,10 +88656,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *327
- - *328
- - *592
- - *531
+ - *324
+ - *325
+ - *589
+ - *528
responses:
'204':
description: Response
@@ -89131,9 +88683,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
- *17
- *19
responses:
@@ -89150,7 +88702,7 @@ paths:
oneOf:
- allOf:
- *286
- - &593
+ - &590
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -89171,67 +88723,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *287
- - *593
+ - *590
- allOf:
- *288
- - *593
+ - *590
- allOf:
- *289
- - *593
+ - *590
- allOf:
- - *594
- - *593
+ - *591
+ - *590
- allOf:
- *290
- - *593
+ - *590
- allOf:
- *291
- - *593
+ - *590
- allOf:
- *292
- - *593
+ - *590
- allOf:
- *293
- - *593
+ - *590
- allOf:
- *294
- - *593
+ - *590
- allOf:
- *295
- - *593
+ - *590
- allOf:
- *296
- - *593
+ - *590
- allOf:
- *297
- - *593
+ - *590
- allOf:
- *298
- - *593
+ - *590
- allOf:
- *299
- - *593
+ - *590
- allOf:
- *300
- - *593
+ - *590
- allOf:
- *301
- - *593
+ - *590
- allOf:
- *302
- - *593
+ - *590
- allOf:
- *303
- - *593
+ - *590
- allOf:
- *304
- - *593
+ - *590
- allOf:
- *305
- - *593
+ - *590
- allOf:
- *306
- - *593
+ - *590
examples:
default:
value:
@@ -89270,8 +88822,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
- name: includes_parents
@@ -89282,7 +88834,7 @@ paths:
schema:
type: boolean
default: true
- - *595
+ - *592
responses:
'200':
description: Response
@@ -89337,8 +88889,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
description: Request body
required: true
@@ -89367,7 +88919,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *596
+ items: *593
required:
- name
- enforcement
@@ -89400,7 +88952,7 @@ paths:
application/json:
schema: *307
examples:
- default: &606
+ default: &603
value:
id: 42
name: super cool ruleset
@@ -89447,12 +88999,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *327
- - *328
+ - *324
+ - *325
+ - *594
+ - *595
+ - *596
- *597
- - *598
- - *599
- - *600
- *17
- *19
responses:
@@ -89460,9 +89012,9 @@ paths:
description: Response
content:
application/json:
- schema: *601
+ schema: *598
examples:
- default: *602
+ default: *599
'404': *6
'500': *112
x-github:
@@ -89483,17 +89035,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *327
- - *328
- - *603
+ - *324
+ - *325
+ - *600
responses:
'200':
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- default: *605
+ default: *602
'404': *6
'500': *112
x-github:
@@ -89521,8 +89073,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89544,7 +89096,7 @@ paths:
application/json:
schema: *307
examples:
- default: *606
+ default: *603
'404': *6
'500': *112
put:
@@ -89562,8 +89114,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89597,7 +89149,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *596
+ items: *593
examples:
default:
value:
@@ -89627,7 +89179,7 @@ paths:
application/json:
schema: *307
examples:
- default: *606
+ default: *603
'404': *6
'500': *112
delete:
@@ -89645,8 +89197,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89669,8 +89221,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
- name: ruleset_id
@@ -89688,7 +89240,7 @@ paths:
type: array
items: *310
examples:
- default: *607
+ default: *604
'404': *6
'500': *112
x-github:
@@ -89707,8 +89259,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89726,7 +89278,7 @@ paths:
description: Response
content:
application/json:
- schema: *608
+ schema: *605
examples:
default:
value:
@@ -89781,22 +89333,22 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
+ - *606
+ - *607
+ - *608
- *609
- *610
- - *611
- - *612
- - *613
- *53
- *19
- *17
+ - *611
+ - *612
+ - *613
- *614
- *615
- *616
- - *617
- - *618
- - *619
responses:
'200':
description: Response
@@ -89804,7 +89356,7 @@ paths:
application/json:
schema:
type: array
- items: &623
+ items: &620
type: object
properties:
number: *170
@@ -89823,8 +89375,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *620
- resolution: *621
+ state: *617
+ resolution: *618
resolved_at:
type: string
format: date-time
@@ -89920,7 +89472,7 @@ paths:
pull request.
'
- oneOf: *622
+ oneOf: *619
nullable: true
has_more_locations:
type: boolean
@@ -90069,16 +89621,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *327
- - *328
- - *425
- - *619
+ - *324
+ - *325
+ - *422
+ - *616
responses:
'200':
description: Response
content:
application/json:
- schema: *623
+ schema: *620
examples:
default:
value:
@@ -90132,9 +89684,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
requestBody:
required: true
content:
@@ -90142,8 +89694,8 @@ paths:
schema:
type: object
properties:
- state: *620
- resolution: *621
+ state: *617
+ resolution: *618
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -90177,7 +89729,7 @@ paths:
description: Response
content:
application/json:
- schema: *623
+ schema: *620
examples:
default:
value:
@@ -90272,9 +89824,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
- *19
- *17
responses:
@@ -90285,7 +89837,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &781
+ items: &776
type: object
properties:
type:
@@ -90311,6 +89863,9 @@ paths:
example: commit
details:
oneOf:
+ - *621
+ - *622
+ - *623
- *624
- *625
- *626
@@ -90321,9 +89876,6 @@ paths:
- *631
- *632
- *633
- - *634
- - *635
- - *636
examples:
default:
value:
@@ -90409,8 +89961,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -90418,14 +89970,14 @@ paths:
schema:
type: object
properties:
- reason: &638
+ reason: &635
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *637
+ placeholder_id: *634
required:
- reason
- placeholder_id
@@ -90442,7 +89994,7 @@ paths:
schema:
type: object
properties:
- reason: *638
+ reason: *635
expire_at:
type: string
format: date-time
@@ -90488,8 +90040,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -90504,7 +90056,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &639
+ items: &636
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -90530,15 +90082,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *639
+ items: *636
backfill_scans:
type: array
- items: *639
+ items: *636
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *639
+ - *636
- type: object
properties:
pattern_name:
@@ -90608,8 +90160,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *53
- name: sort
description: The property to sort the results by.
@@ -90653,9 +90205,9 @@ paths:
application/json:
schema:
type: array
- items: *640
+ items: *637
examples:
- default: *641
+ default: *638
'400': *14
'404': *6
x-github:
@@ -90678,8 +90230,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -90839,9 +90391,9 @@ paths:
description: Response
content:
application/json:
- schema: *640
+ schema: *637
examples:
- default: &643
+ default: &640
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -91074,8 +90626,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -91179,7 +90731,7 @@ paths:
description: Response
content:
application/json:
- schema: *640
+ schema: *637
examples:
default:
value:
@@ -91326,17 +90878,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *327
- - *328
- - *642
+ - *324
+ - *325
+ - *639
responses:
'200':
description: Response
content:
application/json:
- schema: *640
+ schema: *637
examples:
- default: *643
+ default: *640
'403': *29
'404': *6
x-github:
@@ -91360,9 +90912,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *327
- - *328
- - *642
+ - *324
+ - *325
+ - *639
requestBody:
required: true
content:
@@ -91521,10 +91073,10 @@ paths:
description: Response
content:
application/json:
- schema: *640
+ schema: *637
examples:
- default: *643
- add_credit: *643
+ default: *640
+ add_credit: *640
'403': *29
'404': *6
'422':
@@ -91562,9 +91114,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- - *327
- - *328
- - *642
+ - *324
+ - *325
+ - *639
responses:
'202': *39
'400': *14
@@ -91591,17 +91143,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *327
- - *328
- - *642
+ - *324
+ - *325
+ - *639
responses:
'202':
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
+ default: *329
'400': *14
'422': *15
'403': *29
@@ -91627,8 +91179,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-stargazers
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -91727,8 +91279,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -91737,7 +91289,7 @@ paths:
application/json:
schema:
type: array
- items: &644
+ items: &641
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -91770,8 +91322,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -91847,8 +91399,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -91944,8 +91496,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -92099,8 +91651,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -92110,7 +91662,7 @@ paths:
application/json:
schema:
type: array
- items: *644
+ items: *641
examples:
default:
value:
@@ -92143,8 +91695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#create-a-commit-status
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sha
in: path
required: true
@@ -92198,7 +91750,7 @@ paths:
description: Response
content:
application/json:
- schema: *645
+ schema: *642
examples:
default:
value:
@@ -92252,8 +91804,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#list-watchers
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -92285,14 +91837,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &646
+ schema: &643
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -92360,8 +91912,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -92387,7 +91939,7 @@ paths:
description: Response
content:
application/json:
- schema: *646
+ schema: *643
examples:
default:
value:
@@ -92414,8 +91966,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -92435,8 +91987,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-tags
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -92515,8 +92067,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -92524,7 +92076,7 @@ paths:
application/json:
schema:
type: array
- items: &647
+ items: &644
title: Tag protection
description: Tag protection
type: object
@@ -92576,8 +92128,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -92600,7 +92152,7 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *644
examples:
default:
value:
@@ -92631,8 +92183,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:
- - *327
- - *328
+ - *324
+ - *325
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -92669,8 +92221,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ref
in: path
required: true
@@ -92706,8 +92258,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-teams
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -92739,8 +92291,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-all-repository-topics
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *19
- *17
responses:
@@ -92748,7 +92300,7 @@ paths:
description: Response
content:
application/json:
- schema: &648
+ schema: &645
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -92760,7 +92312,7 @@ paths:
required:
- names
examples:
- default: &649
+ default: &646
value:
names:
- octocat
@@ -92783,8 +92335,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -92815,9 +92367,9 @@ paths:
description: Response
content:
application/json:
- schema: *648
+ schema: *645
examples:
- default: *649
+ default: *646
'404': *6
'422': *7
x-github:
@@ -92838,9 +92390,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-repository-clones
parameters:
- - *327
- - *328
- - &650
+ - *324
+ - *325
+ - &647
name: per
description: The time frame to display results for.
in: query
@@ -92869,7 +92421,7 @@ paths:
example: 128
clones:
type: array
- items: &651
+ items: &648
title: Traffic
type: object
properties:
@@ -92956,8 +92508,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -93047,8 +92599,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -93108,9 +92660,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-page-views
parameters:
- - *327
- - *328
- - *650
+ - *324
+ - *325
+ - *647
responses:
'200':
description: Response
@@ -93129,7 +92681,7 @@ paths:
example: 3782
views:
type: array
- items: *651
+ items: *648
required:
- uniques
- count
@@ -93206,8 +92758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#transfer-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -93481,8 +93033,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -93505,8 +93057,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -93528,8 +93080,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -93555,8 +93107,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ref
in: path
required: true
@@ -93648,9 +93200,9 @@ paths:
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
+ default: *329
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -93898,7 +93450,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &652
+ text_matches: &649
title: Search Result Text Matches
type: array
items:
@@ -94060,7 +93612,7 @@ paths:
enum:
- author-date
- committer-date
- - &653
+ - &650
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
@@ -94131,7 +93683,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *392
+ properties: *389
nullable: true
comment_count:
type: integer
@@ -94151,7 +93703,7 @@ paths:
url:
type: string
format: uri
- verification: *513
+ verification: *510
required:
- author
- committer
@@ -94170,7 +93722,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *392
+ properties: *389
nullable: true
parents:
type: array
@@ -94188,7 +93740,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *652
+ text_matches: *649
required:
- sha
- node_id
@@ -94380,7 +93932,7 @@ paths:
- interactions
- created
- updated
- - *653
+ - *650
- *17
- *19
- name: advanced_search
@@ -94477,11 +94029,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
type: string
state_reason:
@@ -94513,7 +94065,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *652
+ text_matches: *649
pull_request:
type: object
properties:
@@ -94738,7 +94290,7 @@ paths:
enum:
- created
- updated
- - *653
+ - *650
- *17
- *19
responses:
@@ -94782,7 +94334,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *652
+ text_matches: *649
required:
- id
- node_id
@@ -94867,7 +94419,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *653
+ - *650
- *17
- *19
responses:
@@ -95106,7 +94658,7 @@ paths:
- admin
- pull
- push
- text_matches: *652
+ text_matches: *649
temp_clone_token:
type: string
allow_merge_commit:
@@ -95406,7 +94958,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *652
+ text_matches: *649
related:
type: array
nullable: true
@@ -95597,7 +95149,7 @@ paths:
- followers
- repositories
- joined
- - *653
+ - *650
- *17
- *19
responses:
@@ -95701,7 +95253,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *652
+ text_matches: *649
blog:
type: string
nullable: true
@@ -95780,7 +95332,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#get-a-team-legacy
parameters:
- - &657
+ - &654
name: team_id
description: The unique identifier of the team.
in: path
@@ -95821,7 +95373,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#update-a-team-legacy
parameters:
- - *657
+ - *654
requestBody:
required: true
content:
@@ -95921,7 +95473,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy
parameters:
- - *657
+ - *654
responses:
'204':
description: Response
@@ -95935,226 +95487,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
- parameters:
- - *657
- - *53
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *323
- examples:
- default: *658
- headers:
- Link: *59
- 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]
- > **Endpoint closing down notice:** 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.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - *657
- 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: *323
- examples:
- default: *324
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - *657
- - *325
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *323
- examples:
- default: *324
- 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]
- > **Endpoint closing down notice:** 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.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth 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:
- - *657
- - *325
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *323
- examples:
- default: *659
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - *657
- - *325
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -96170,7 +95502,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *657
+ - *654
- *17
- *19
responses:
@@ -96208,7 +95540,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-team-members-legacy
parameters:
- - *657
+ - *654
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -96259,7 +95591,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-member-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'204':
@@ -96296,7 +95628,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-team-member-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'204':
@@ -96336,7 +95668,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-member-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'204':
@@ -96373,16 +95705,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'200':
description: Response
content:
application/json:
- schema: *326
+ schema: *323
examples:
- response-if-user-is-a-team-maintainer: *660
+ response-if-user-is-a-team-maintainer: *655
'404': *6
x-github:
githubCloudOnly: false
@@ -96415,7 +95747,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *657
+ - *654
- *64
requestBody:
required: false
@@ -96441,9 +95773,9 @@ paths:
description: Response
content:
application/json:
- schema: *326
+ schema: *323
examples:
- response-if-users-membership-with-team-is-now-pending: *661
+ response-if-users-membership-with-team-is-now-pending: *656
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -96477,7 +95809,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'204':
@@ -96505,7 +95837,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
parameters:
- - *657
+ - *654
- *17
- *19
responses:
@@ -96547,15 +95879,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *657
- - *327
- - *328
+ - *654
+ - *324
+ - *325
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *662
+ schema: *657
examples:
alternative-response-with-extra-repository-information:
value:
@@ -96706,9 +96038,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *657
- - *327
- - *328
+ - *654
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -96758,9 +96090,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *657
- - *327
- - *328
+ - *654
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -96785,7 +96117,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy
parameters:
- - *657
+ - *654
- *17
- *19
responses:
@@ -96797,7 +96129,7 @@ paths:
type: array
items: *189
examples:
- response-if-child-teams-exist: *663
+ response-if-child-teams-exist: *658
headers:
Link: *59
'404': *6
@@ -96830,7 +96162,7 @@ paths:
application/json:
schema:
oneOf:
- - &665
+ - &660
title: Private User
description: Private User
type: object
@@ -97033,7 +96365,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *664
+ - *659
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -97186,7 +96518,7 @@ paths:
description: Response
content:
application/json:
- schema: *665
+ schema: *660
examples:
default:
value:
@@ -97532,7 +96864,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -97540,7 +96872,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'401': *25
'403': *29
'404': *6
@@ -97584,7 +96916,7 @@ paths:
type: integer
secrets:
type: array
- items: &666
+ items: &661
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -97624,7 +96956,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *451
+ default: *448
headers:
Link: *59
x-github:
@@ -97700,7 +97032,7 @@ paths:
description: Response
content:
application/json:
- schema: *666
+ schema: *661
examples:
default:
value:
@@ -97846,7 +97178,7 @@ paths:
type: array
items: *152
examples:
- default: *667
+ default: *662
'401': *25
'403': *29
'404': *6
@@ -97998,7 +97330,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'304': *37
'500': *112
'401': *25
@@ -98056,7 +97388,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'401': *25
'403': *29
'404': *6
@@ -98113,7 +97445,7 @@ paths:
description: Response
content:
application/json:
- schema: &668
+ schema: &663
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -98154,7 +97486,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &669
+ default: &664
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -98199,9 +97531,9 @@ paths:
description: Response
content:
application/json:
- schema: *668
+ schema: *663
examples:
- default: *669
+ default: *664
'404': *6
x-github:
githubCloudOnly: false
@@ -98238,9 +97570,9 @@ paths:
type: integer
machines:
type: array
- items: *670
+ items: *665
examples:
- default: *671
+ default: *666
'304': *37
'500': *112
'401': *25
@@ -98319,13 +97651,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *330
+ repository: *327
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *449
- required: *450
+ properties: *446
+ required: *447
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -99107,7 +98439,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'304': *37
'500': *112
'400': *14
@@ -99147,7 +98479,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'500': *112
'401': *25
'403': *29
@@ -99179,7 +98511,7 @@ paths:
type: array
items: *245
examples:
- default: &682
+ default: &677
value:
- id: 197
name: hello_docker
@@ -99280,7 +98612,7 @@ paths:
application/json:
schema:
type: array
- items: &672
+ items: &667
title: Email
description: Email
type: object
@@ -99345,9 +98677,9 @@ paths:
application/json:
schema:
type: array
- items: *672
+ items: *667
examples:
- default: &684
+ default: &679
value:
- email: octocat@github.com
verified: true
@@ -99422,7 +98754,7 @@ paths:
application/json:
schema:
type: array
- items: *672
+ items: *667
examples:
default:
value:
@@ -99678,7 +99010,7 @@ paths:
application/json:
schema:
type: array
- items: &673
+ items: &668
title: GPG Key
description: A unique encryption key
type: object
@@ -99809,7 +99141,7 @@ paths:
- subkeys
- revoked
examples:
- default: &698
+ default: &693
value:
- id: 3
name: Octocat's GPG Key
@@ -99894,9 +99226,9 @@ paths:
description: Response
content:
application/json:
- schema: *673
+ schema: *668
examples:
- default: &674
+ default: &669
value:
id: 3
name: Octocat's GPG Key
@@ -99953,7 +99285,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &675
+ - &670
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -99965,9 +99297,9 @@ paths:
description: Response
content:
application/json:
- schema: *673
+ schema: *668
examples:
- default: *674
+ default: *669
'404': *6
'304': *37
'403': *29
@@ -99990,7 +99322,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *675
+ - *670
responses:
'204':
description: Response
@@ -100295,7 +99627,7 @@ paths:
required: true
content:
application/json:
- schema: *524
+ schema: *521
examples:
default:
value:
@@ -100445,7 +99777,7 @@ paths:
application/json:
schema:
type: array
- items: &676
+ items: &671
title: Key
description: Key
type: object
@@ -100546,9 +99878,9 @@ paths:
description: Response
content:
application/json:
- schema: *676
+ schema: *671
examples:
- default: &677
+ default: &672
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -100581,15 +99913,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *555
+ - *552
responses:
'200':
description: Response
content:
application/json:
- schema: *676
+ schema: *671
examples:
- default: *677
+ default: *672
'404': *6
'304': *37
'403': *29
@@ -100612,7 +99944,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *555
+ - *552
responses:
'204':
description: Response
@@ -100645,7 +99977,7 @@ paths:
application/json:
schema:
type: array
- items: &678
+ items: &673
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -100713,7 +100045,7 @@ paths:
- account
- plan
examples:
- default: &679
+ default: &674
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -100775,9 +100107,9 @@ paths:
application/json:
schema:
type: array
- items: *678
+ items: *673
examples:
- default: *679
+ default: *674
headers:
Link: *59
'304': *37
@@ -101786,7 +101118,7 @@ paths:
url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository
parameters:
- *239
- - *680
+ - *675
responses:
'204':
description: Response
@@ -101901,7 +101233,7 @@ paths:
- docker
- nuget
- container
- - *681
+ - *676
- *19
- *17
responses:
@@ -101913,8 +101245,8 @@ paths:
type: array
items: *245
examples:
- default: *682
- '400': *683
+ default: *677
+ '400': *678
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -101943,7 +101275,7 @@ paths:
application/json:
schema: *245
examples:
- default: &699
+ default: &694
value:
id: 40201
name: octo-name
@@ -102305,9 +101637,9 @@ paths:
application/json:
schema:
type: array
- items: *672
+ items: *667
examples:
- default: *684
+ default: *679
headers:
Link: *59
'304': *37
@@ -102420,7 +101752,7 @@ paths:
type: array
items: *71
examples:
- default: &691
+ default: &686
summary: Default response
value:
- id: 1296269
@@ -102724,9 +102056,9 @@ paths:
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
+ default: *329
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -102764,9 +102096,9 @@ paths:
application/json:
schema:
type: array
- items: *526
+ items: *523
examples:
- default: *685
+ default: *680
headers:
Link: *59
'304': *37
@@ -102845,7 +102177,7 @@ paths:
application/json:
schema:
type: array
- items: &686
+ items: &681
title: Social account
description: Social media account
type: object
@@ -102860,7 +102192,7 @@ paths:
- provider
- url
examples:
- default: &687
+ default: &682
value:
- provider: twitter
url: https://twitter.com/github
@@ -102922,9 +102254,9 @@ paths:
application/json:
schema:
type: array
- items: *686
+ items: *681
examples:
- default: *687
+ default: *682
'422': *15
'304': *37
'404': *6
@@ -103011,7 +102343,7 @@ paths:
application/json:
schema:
type: array
- items: &688
+ items: &683
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -103031,7 +102363,7 @@ paths:
- title
- created_at
examples:
- default: &717
+ default: &712
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -103095,9 +102427,9 @@ paths:
description: Response
content:
application/json:
- schema: *688
+ schema: *683
examples:
- default: &689
+ default: &684
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -103127,7 +102459,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &690
+ - &685
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -103139,9 +102471,9 @@ paths:
description: Response
content:
application/json:
- schema: *688
+ schema: *683
examples:
- default: *689
+ default: *684
'404': *6
'304': *37
'403': *29
@@ -103164,7 +102496,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *690
+ - *685
responses:
'204':
description: Response
@@ -103193,7 +102525,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &718
+ - &713
name: sort
description: The property to sort the results by. `created` means when the
repository was starred. `updated` means when the repository was last pushed
@@ -103218,11 +102550,11 @@ paths:
type: array
items: *71
examples:
- default-response: *691
+ default-response: *686
application/vnd.github.v3.star+json:
schema:
type: array
- items: &719
+ items: &714
title: Starred Repository
description: Starred Repository
type: object
@@ -103378,8 +102710,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response if this repository is starred by you
@@ -103407,8 +102739,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -103432,8 +102764,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -103591,10 +102923,10 @@ paths:
application/json:
schema:
oneOf:
- - *665
- - *664
+ - *660
+ - *659
examples:
- default-response: &693
+ default-response: &688
summary: Default response
value:
login: octocat
@@ -103629,7 +102961,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &694
+ response-with-git-hub-plan-information: &689
summary: Response with GitHub plan information
value:
login: octocat
@@ -103751,7 +103083,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/users#list-users
parameters:
- - *692
+ - *687
- *17
responses:
'200':
@@ -103800,11 +103132,11 @@ paths:
application/json:
schema:
oneOf:
- - *665
- - *664
+ - *660
+ - *659
examples:
- default-response: *693
- response-with-git-hub-plan-information: *694
+ default-response: *688
+ response-with-git-hub-plan-information: *689
'404': *6
x-github:
githubCloudOnly: false
@@ -103854,8 +103186,8 @@ paths:
required:
- subject_digests
examples:
- default: *695
- withPredicateType: *696
+ default: *690
+ withPredicateType: *691
responses:
'200':
description: Response
@@ -103908,7 +103240,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *697
+ default: *692
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104113,7 +103445,7 @@ paths:
initiator:
type: string
examples:
- default: *388
+ default: *385
'201':
description: Response
content:
@@ -104154,7 +103486,7 @@ paths:
type: array
items: *245
examples:
- default: *682
+ default: *677
'403': *29
'401': *25
x-github:
@@ -104538,9 +103870,9 @@ paths:
application/json:
schema:
type: array
- items: *673
+ items: *668
examples:
- default: *698
+ default: *693
headers:
Link: *59
x-github:
@@ -104644,7 +103976,7 @@ paths:
application/json:
schema: *22
examples:
- default: *523
+ default: *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -104768,7 +104100,7 @@ paths:
- docker
- nuget
- container
- - *681
+ - *676
- *64
- *19
- *17
@@ -104781,10 +104113,10 @@ paths:
type: array
items: *245
examples:
- default: *682
+ default: *677
'403': *29
'401': *25
- '400': *683
+ '400': *678
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -104814,7 +104146,7 @@ paths:
application/json:
schema: *245
examples:
- default: *699
+ default: *694
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -105163,7 +104495,7 @@ paths:
type: array
items: *267
examples:
- default: *700
+ default: *695
headers:
Link: *59
'304': *37
@@ -105223,7 +104555,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *701
+ items: *696
required:
- name
- data_type
@@ -105239,7 +104571,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *702
+ iteration_configuration: *697
required:
- name
- data_type
@@ -105261,8 +104593,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *703
- iteration_field: *704
+ single_select_field: *698
+ iteration_field: *699
responses:
'201':
description: Response
@@ -105270,11 +104602,11 @@ paths:
application/json:
schema: *267
examples:
- text_field: *705
- number_field: *706
- date_field: *707
- single_select_field: *708
- iteration_field: *709
+ text_field: *700
+ number_field: *701
+ date_field: *702
+ single_select_field: *703
+ iteration_field: *704
'304': *37
'403': *29
'401': *25
@@ -105296,7 +104628,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-user
parameters:
- *263
- - *710
+ - *705
- *64
responses:
'200':
@@ -105305,7 +104637,7 @@ paths:
application/json:
schema: *267
examples:
- default: *711
+ default: *706
headers:
Link: *59
'304': *37
@@ -105659,7 +104991,7 @@ paths:
parameters:
- *263
- *64
- - *712
+ - *707
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -105934,7 +105266,7 @@ paths:
- *115
- *117
- *116
- - *713
+ - *708
- *118
responses:
'200':
@@ -106065,7 +105397,7 @@ paths:
parameters:
- *64
- *115
- - *714
+ - *709
- *116
responses:
'200':
@@ -106164,9 +105496,9 @@ paths:
- *115
- *117
- *116
- - *715
+ - *710
- *118
- - *716
+ - *711
responses:
'200':
description: Response when getting a billing usage summary
@@ -106300,9 +105632,9 @@ paths:
application/json:
schema:
type: array
- items: *686
+ items: *681
examples:
- default: *687
+ default: *682
headers:
Link: *59
x-github:
@@ -106332,9 +105664,9 @@ paths:
application/json:
schema:
type: array
- items: *688
+ items: *683
examples:
- default: *717
+ default: *712
headers:
Link: *59
x-github:
@@ -106359,7 +105691,7 @@ paths:
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *64
- - *718
+ - *713
- *53
- *17
- *19
@@ -106371,11 +105703,11 @@ paths:
schema:
anyOf:
- type: array
- items: *719
+ items: *714
- type: array
items: *71
examples:
- default-response: *691
+ default-response: *686
headers:
Link: *59
x-github:
@@ -106534,7 +105866,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &720
+ enterprise: &715
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -106592,7 +105924,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &721
+ installation: &716
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -106611,7 +105943,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &722
+ organization: &717
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -106671,13 +106003,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &723
+ repository: &718
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: &753
+ properties: &748
id:
description: Unique identifier of the repository
example: 42
@@ -107360,7 +106692,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &754
+ required: &749
- archive_url
- assignees_url
- blobs_url
@@ -107511,10 +106843,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -107590,11 +106922,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- rule: &724
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ rule: &719
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -107817,11 +107149,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- rule: *724
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ rule: *719
sender: *4
required:
- action
@@ -108004,11 +107336,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- rule: *724
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ rule: *719
sender: *4
required:
- action
@@ -108092,7 +107424,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &726
+ check_run: &721
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -108183,7 +107515,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *725
+ deployment: *720
details_url:
example: https://example.com
type: string
@@ -108268,10 +107600,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *721
- enterprise: *720
- organization: *722
- repository: *723
+ installation: *716
+ enterprise: *715
+ organization: *717
+ repository: *718
sender: *4
required:
- check_run
@@ -108664,11 +107996,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *726
- installation: *721
- enterprise: *720
- organization: *722
- repository: *723
+ check_run: *721
+ installation: *716
+ enterprise: *715
+ organization: *717
+ repository: *718
sender: *4
required:
- check_run
@@ -109064,11 +108396,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *726
- installation: *721
- enterprise: *720
- organization: *722
- repository: *723
+ check_run: *721
+ installation: *716
+ enterprise: *715
+ organization: *717
+ repository: *718
requested_action:
description: The action requested by the user.
type: object
@@ -109473,11 +108805,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *726
- installation: *721
- enterprise: *720
- organization: *722
- repository: *723
+ check_run: *721
+ installation: *716
+ enterprise: *715
+ organization: *717
+ repository: *718
sender: *4
required:
- check_run
@@ -110454,10 +109786,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -111151,10 +110483,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -111842,10 +111174,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -112011,7 +111343,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -112156,20 +111488,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &727
+ commit_oid: &722
description: The commit SHA of the code scanning alert. When the
action is `reopened_by_user` or `closed_by_user`, the event was
triggered by the `sender` and this value will be empty.
type: string
- enterprise: *720
- installation: *721
- organization: *722
- ref: &728
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: &723
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -112334,7 +111666,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -112564,12 +111896,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *727
- enterprise: *720
- installation: *721
- organization: *722
- ref: *728
- repository: *723
+ commit_oid: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: *723
+ repository: *718
sender: *4
required:
- action
@@ -112664,7 +111996,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -112835,12 +112167,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *727
- enterprise: *720
- installation: *721
- organization: *722
- ref: *728
- repository: *723
+ commit_oid: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: *723
+ repository: *718
sender: *4
required:
- action
@@ -113006,7 +112338,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -113172,12 +112504,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *727
- enterprise: *720
- installation: *721
- organization: *722
- ref: *728
- repository: *723
+ commit_oid: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: *723
+ repository: *718
sender: *4
required:
- action
@@ -113276,7 +112608,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -113451,16 +112783,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
nullable: true
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -113557,7 +112889,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -113697,12 +113029,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *727
- enterprise: *720
- installation: *721
- organization: *722
- ref: *728
- repository: *723
+ commit_oid: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: *723
+ repository: *718
sender: *4
required:
- action
@@ -113868,7 +113200,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -114013,10 +113345,10 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -114271,10 +113603,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -114354,18 +113686,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *722
- pusher_type: &729
+ organization: *717
+ pusher_type: &724
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &730
+ ref: &725
description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference)
resource.
type: string
@@ -114375,7 +113707,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *723
+ repository: *718
sender: *4
required:
- ref
@@ -114458,9 +113790,9 @@ x-webhooks:
enum:
- created
definition: *274
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -114545,9 +113877,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -114625,9 +113957,9 @@ x-webhooks:
enum:
- promote_to_enterprise
definition: *274
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -114705,9 +114037,9 @@ x-webhooks:
enum:
- updated
definition: *274
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -114784,10 +114116,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *720
- installation: *721
- repository: *723
- organization: *722
+ enterprise: *715
+ installation: *716
+ repository: *718
+ organization: *717
sender: *4
new_property_values:
type: array
@@ -114872,18 +114204,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
- pusher_type: *729
- ref: *730
+ enterprise: *715
+ installation: *716
+ organization: *717
+ pusher_type: *724
+ ref: *725
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *723
+ repository: *718
sender: *4
required:
- ref
@@ -114967,11 +114299,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115055,11 +114387,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115143,11 +114475,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115229,11 +114561,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115315,11 +114647,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115402,11 +114734,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115488,11 +114820,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115569,9 +114901,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- key: &731
+ enterprise: *715
+ installation: *716
+ key: &726
description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -115607,8 +114939,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -115685,11 +115017,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- key: *731
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ key: *726
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -116250,12 +115582,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: &735
+ workflow: &730
title: Workflow
type: object
nullable: true
@@ -116981,13 +116313,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *488
+ deployment: *485
pull_requests:
type: array
- items: *576
- repository: *723
- organization: *722
- installation: *721
+ items: *573
+ repository: *718
+ organization: *717
+ installation: *716
sender: *4
responses:
'200':
@@ -117058,7 +116390,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &732
+ approver: &727
type: object
properties:
avatar_url:
@@ -117101,11 +116433,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- reviewers: &733
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ reviewers: &728
type: array
items:
type: object
@@ -117184,7 +116516,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &734
+ workflow_job_run: &729
type: object
properties:
conclusion:
@@ -117915,18 +117247,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *732
+ approver: *727
comment:
type: string
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- reviewers: *733
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ reviewers: *728
sender: *4
since:
type: string
- workflow_job_run: *734
+ workflow_job_run: *729
workflow_job_runs:
type: array
items:
@@ -118630,13 +117962,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *720
+ enterprise: *715
environment:
type: string
- installation: *721
- organization: *722
- repository: *723
- requestor: &740
+ installation: *716
+ organization: *717
+ repository: *718
+ requestor: &735
title: User
type: object
nullable: true
@@ -120535,12 +119867,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: *735
+ workflow: *730
workflow_run:
title: Deployment Workflow Run
type: object
@@ -121220,7 +120552,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &738
+ answer: &733
type: object
properties:
author_association:
@@ -121377,11 +120709,11 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -121508,11 +120840,11 @@ x-webhooks:
- from
required:
- category
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -121595,11 +120927,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -121681,7 +121013,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &737
+ comment: &732
type: object
properties:
author_association:
@@ -121838,11 +121170,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -121925,12 +121257,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *737
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ comment: *732
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122025,12 +121357,12 @@ x-webhooks:
- from
required:
- body
- comment: *737
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ comment: *732
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122114,11 +121446,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122200,11 +121532,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122304,11 +121636,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122390,10 +121722,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *736
- enterprise: *720
- installation: *721
- label: &739
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ label: &734
title: Label
type: object
properties:
@@ -122425,8 +121757,8 @@ x-webhooks:
- color
- default
- description
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122509,11 +121841,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122595,11 +121927,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122681,11 +122013,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122770,16 +122102,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *736
- new_repository: *723
+ new_discussion: *731
+ new_repository: *718
required:
- new_discussion
- new_repository
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122862,10 +122194,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *736
- old_answer: *738
- organization: *722
- repository: *723
+ discussion: *731
+ old_answer: *733
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122947,12 +122279,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *736
- enterprise: *720
- installation: *721
- label: *739
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -123035,11 +122367,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -123121,11 +122453,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -123198,7 +122530,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *720
+ enterprise: *715
forkee:
description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository)
resource.
@@ -123858,9 +123190,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- forkee
@@ -124006,9 +123338,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pages:
description: The pages that were updated.
type: array
@@ -124045,7 +123377,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *723
+ repository: *718
sender: *4
required:
- pages
@@ -124121,10 +123453,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: &741
+ organization: *717
+ repositories: &736
description: An array of repository objects that the installation
can access.
type: array
@@ -124150,8 +123482,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *723
- requester: *740
+ repository: *718
+ requester: *735
sender: *4
required:
- action
@@ -124226,11 +123558,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: *741
- repository: *723
+ organization: *717
+ repositories: *736
+ repository: *718
requester:
nullable: true
sender: *4
@@ -124306,11 +123638,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: *741
- repository: *723
+ organization: *717
+ repositories: *736
+ repository: *718
requester:
nullable: true
sender: *4
@@ -124386,10 +123718,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories_added: &742
+ organization: *717
+ repositories_added: &737
description: An array of repository objects, which were added to
the installation.
type: array
@@ -124435,15 +123767,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *723
- repository_selection: &743
+ repository: *718
+ repository_selection: &738
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *740
+ requester: *735
sender: *4
required:
- action
@@ -124522,10 +123854,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories_added: *742
+ organization: *717
+ repositories_added: *737
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -124552,9 +123884,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *723
- repository_selection: *743
- requester: *740
+ repository: *718
+ repository_selection: *738
+ requester: *735
sender: *4
required:
- action
@@ -124633,11 +123965,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: *741
- repository: *723
+ organization: *717
+ repositories: *736
+ repository: *718
requester:
nullable: true
sender: *4
@@ -124815,10 +124147,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
target_type:
type: string
@@ -124897,11 +124229,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: *741
- repository: *723
+ organization: *717
+ repositories: *736
+ repository: *718
requester:
nullable: true
sender: *4
@@ -125153,8 +124485,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -125948,8 +125280,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -126298,8 +125630,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -126379,7 +125711,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &744
+ comment: &739
title: issue comment
description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment)
itself.
@@ -126544,8 +125876,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -127335,8 +126667,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -127687,8 +127019,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -127768,7 +127100,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &773
+ changes: &768
description: The changes to the comment.
type: object
properties:
@@ -127780,9 +127112,9 @@ x-webhooks:
type: string
required:
- from
- comment: *744
- enterprise: *720
- installation: *721
+ comment: *739
+ enterprise: *715
+ installation: *716
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -128575,8 +127907,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -128925,8 +128257,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129016,9 +128348,9 @@ x-webhooks:
type: number
blocking_issue: *75
blocking_issue_repo: *71
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129107,9 +128439,9 @@ x-webhooks:
type: number
blocking_issue: *75
blocking_issue_repo: *71
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129197,9 +128529,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129288,9 +128620,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129370,10 +128702,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *740
- enterprise: *720
- installation: *721
- issue: &747
+ assignee: *735
+ enterprise: *715
+ installation: *716
+ issue: &742
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -130162,11 +129494,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -130283,8 +129615,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -130364,8 +129696,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -131159,11 +130491,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -131415,8 +130747,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -131495,8 +130827,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -132281,11 +131613,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -132401,8 +131733,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -132481,8 +131813,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -133289,11 +132621,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -133388,7 +132720,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &745
+ milestone: &740
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -133526,8 +132858,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -133626,8 +132958,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -134416,11 +133748,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -134537,9 +133869,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *739
- organization: *722
- repository: *723
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -134619,8 +133951,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -135408,11 +134740,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -135529,9 +134861,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *739
- organization: *722
- repository: *723
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -135611,8 +134943,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -136424,11 +135756,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -136522,8 +135854,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -136602,8 +135934,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -137409,11 +136741,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -137507,9 +136839,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *745
- organization: *722
- repository: *723
+ milestone: *740
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -138377,11 +137709,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -138943,8 +138275,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -139733,11 +139065,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -139853,8 +139185,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -139934,9 +139266,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *720
- installation: *721
- issue: &746
+ enterprise: *715
+ installation: *716
+ issue: &741
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -140719,11 +140051,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -140839,8 +140171,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -140919,8 +140251,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -141730,11 +141062,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -141829,8 +141161,8 @@ x-webhooks:
user_view_type:
type: string
type: *227
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -142696,11 +142028,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143284,11 +142616,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *720
- installation: *721
- issue: *746
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ issue: *741
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -143368,12 +142700,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *720
- installation: *721
- issue: *747
+ enterprise: *715
+ installation: *716
+ issue: *742
type: *227
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -143454,7 +142786,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &776
+ assignee: &771
title: User
type: object
nullable: true
@@ -143524,11 +142856,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *720
- installation: *721
- issue: *747
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ issue: *742
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -143607,12 +142939,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *720
- installation: *721
- issue: *747
- label: *739
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ issue: *742
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -143692,8 +143024,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -144503,11 +143835,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -144601,8 +143933,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -144682,11 +144014,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *720
- installation: *721
- issue: *746
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ issue: *741
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -144765,12 +144097,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *720
- installation: *721
- issue: *747
+ enterprise: *715
+ installation: *716
+ issue: *742
type: *227
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -144850,11 +144182,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- label: *739
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -144932,11 +144264,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- label: *739
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -145046,11 +144378,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- label: *739
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -145132,9 +144464,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *720
- installation: *721
- marketplace_purchase: &748
+ enterprise: *715
+ installation: *716
+ marketplace_purchase: &743
title: Marketplace Purchase
type: object
required:
@@ -145217,8 +144549,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *722
- previous_marketplace_purchase: &749
+ organization: *717
+ previous_marketplace_purchase: &744
title: Marketplace Purchase
type: object
properties:
@@ -145298,7 +144630,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -145378,10 +144710,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *720
- installation: *721
- marketplace_purchase: *748
- organization: *722
+ enterprise: *715
+ installation: *716
+ marketplace_purchase: *743
+ organization: *717
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -145464,7 +144796,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -145546,10 +144878,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *720
- installation: *721
- marketplace_purchase: *748
- organization: *722
+ enterprise: *715
+ installation: *716
+ marketplace_purchase: *743
+ organization: *717
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -145631,7 +144963,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -145712,8 +145044,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -145795,9 +145127,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *722
- previous_marketplace_purchase: *749
- repository: *723
+ organization: *717
+ previous_marketplace_purchase: *744
+ repository: *718
sender: *4
required:
- action
@@ -145877,12 +145209,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *720
- installation: *721
- marketplace_purchase: *748
- organization: *722
- previous_marketplace_purchase: *749
- repository: *723
+ enterprise: *715
+ installation: *716
+ marketplace_purchase: *743
+ organization: *717
+ previous_marketplace_purchase: *744
+ repository: *718
sender: *4
required:
- action
@@ -145984,11 +145316,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146088,11 +145420,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146171,11 +145503,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146253,11 +145585,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -146333,7 +145665,7 @@ x-webhooks:
required:
- login
- id
- team: &750
+ team: &745
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -146556,11 +145888,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -146637,7 +145969,7 @@ x-webhooks:
required:
- login
- id
- team: *750
+ team: *745
required:
- action
- scope
@@ -146719,8 +146051,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *721
- merge_group: &752
+ installation: *716
+ merge_group: &747
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -146739,15 +146071,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *751
+ head_commit: *746
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146833,10 +146165,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *721
- merge_group: *752
- organization: *722
- repository: *723
+ installation: *716
+ merge_group: *747
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146909,7 +146241,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
+ enterprise: *715
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -147018,16 +146350,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *753
- required: *754
+ properties: *748
+ required: *749
nullable: true
sender: *4
required:
@@ -147108,11 +146440,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *720
- installation: *721
- milestone: *745
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ milestone: *740
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147191,9 +146523,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- milestone: &755
+ enterprise: *715
+ installation: *716
+ milestone: &750
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -147330,8 +146662,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147410,11 +146742,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- milestone: *745
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ milestone: *740
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147524,11 +146856,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- milestone: *745
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ milestone: *740
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147608,11 +146940,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *720
- installation: *721
- milestone: *755
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ milestone: *750
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147691,11 +147023,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *740
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ blocked_user: *735
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147774,11 +147106,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *740
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ blocked_user: *735
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147857,9 +147189,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- membership: &756
+ enterprise: *715
+ installation: *716
+ membership: &751
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -147966,8 +147298,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -148045,11 +147377,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *720
- installation: *721
- membership: *756
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ membership: *751
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -148128,8 +147460,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -148245,10 +147577,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
- user: *740
+ user: *735
required:
- action
- invitation
@@ -148326,11 +147658,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *720
- installation: *721
- membership: *756
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ membership: *751
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -148417,11 +147749,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *720
- installation: *721
- membership: *756
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ membership: *751
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -148497,9 +147829,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
package:
description: Information about the package.
type: object
@@ -148998,7 +148330,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &757
+ items: &752
title: Ruby Gems metadata
type: object
properties:
@@ -149093,7 +148425,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -149169,9 +148501,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
package:
description: Information about the package.
type: object
@@ -149524,7 +148856,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *757
+ items: *752
source_url:
type: string
format: uri
@@ -149594,7 +148926,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -149771,12 +149103,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *720
+ enterprise: *715
id:
type: integer
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- id
@@ -149853,7 +149185,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &758
+ personal_access_token_request: &753
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -149999,10 +149331,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *720
- organization: *722
+ enterprise: *715
+ organization: *717
sender: *4
- installation: *721
+ installation: *716
required:
- action
- personal_access_token_request
@@ -150079,11 +149411,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *758
- enterprise: *720
- organization: *722
+ personal_access_token_request: *753
+ enterprise: *715
+ organization: *717
sender: *4
- installation: *721
+ installation: *716
required:
- action
- personal_access_token_request
@@ -150159,11 +149491,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *758
- enterprise: *720
- organization: *722
+ personal_access_token_request: *753
+ enterprise: *715
+ organization: *717
sender: *4
- installation: *721
+ installation: *716
required:
- action
- personal_access_token_request
@@ -150238,11 +149570,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *758
- organization: *722
- enterprise: *720
+ personal_access_token_request: *753
+ organization: *717
+ enterprise: *715
sender: *4
- installation: *721
+ installation: *716
required:
- action
- personal_access_token_request
@@ -150347,7 +149679,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *759
+ last_response: *754
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -150379,8 +149711,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
zen:
description: Random string of GitHub zen.
@@ -150625,10 +149957,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *720
- installation: *721
- organization: *722
- project_card: &760
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_card: &755
title: Project Card
type: object
properties:
@@ -150747,7 +150079,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -150828,11 +150160,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- project_card: *760
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_card: *755
+ repository: *718
sender: *4
required:
- action
@@ -150912,9 +150244,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
project_card:
title: Project Card
type: object
@@ -151042,8 +150374,8 @@ x-webhooks:
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *753
- required: *754
+ properties: *748
+ required: *749
nullable: true
sender: *4
required:
@@ -151137,11 +150469,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *720
- installation: *721
- organization: *722
- project_card: *760
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_card: *755
+ repository: *718
sender: *4
required:
- action
@@ -151235,9 +150567,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
project_card:
allOf:
- title: Project Card
@@ -151427,7 +150759,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -151507,10 +150839,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *720
- installation: *721
- organization: *722
- project: &762
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: &757
title: Project
type: object
properties:
@@ -151634,7 +150966,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -151714,10 +151046,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- project_column: &761
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_column: &756
title: Project Column
type: object
properties:
@@ -151756,7 +151088,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -151835,18 +151167,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- project_column: *761
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_column: *756
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *753
- required: *754
+ properties: *748
+ required: *749
nullable: true
sender: *4
required:
@@ -151936,11 +151268,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- project_column: *761
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_column: *756
+ repository: *718
sender: *4
required:
- action
@@ -152020,11 +151352,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *720
- installation: *721
- organization: *722
- project_column: *761
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_column: *756
+ repository: *718
sender: *4
required:
- action
@@ -152104,11 +151436,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- project: *762
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: *757
+ repository: *718
sender: *4
required:
- action
@@ -152188,18 +151520,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- project: *762
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: *757
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *753
- required: *754
+ properties: *748
+ required: *749
nullable: true
sender: *4
required:
@@ -152301,11 +151633,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- project: *762
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: *757
+ repository: *718
sender: *4
required:
- action
@@ -152384,11 +151716,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *720
- installation: *721
- organization: *722
- project: *762
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: *757
+ repository: *718
sender: *4
required:
- action
@@ -152469,8 +151801,8 @@ x-webhooks:
type: string
enum:
- closed
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -152552,8 +151884,8 @@ x-webhooks:
type: string
enum:
- created
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -152635,8 +151967,8 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -152754,8 +152086,8 @@ x-webhooks:
type: string
to:
type: string
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -152839,7 +152171,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &766
+ changes: &761
type: object
properties:
archived_at:
@@ -152853,9 +152185,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *721
- organization: *722
- projects_v2_item: &763
+ installation: *716
+ organization: *717
+ projects_v2_item: &758
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -152990,9 +152322,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153074,9 +152406,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153157,9 +152489,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153265,7 +152597,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &764
+ - &759
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -153287,7 +152619,7 @@ x-webhooks:
required:
- id
- name
- - &765
+ - &760
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -153321,8 +152653,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *764
- - *765
+ - *759
+ - *760
required:
- field_value
- type: object
@@ -153338,9 +152670,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153435,9 +152767,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153520,10 +152852,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *766
- installation: *721
- organization: *722
- projects_v2_item: *763
+ changes: *761
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153605,8 +152937,8 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -153688,14 +153020,14 @@ x-webhooks:
type: string
enum:
- created
- installation: *721
- organization: *722
- projects_v2_status_update: &769
+ installation: *716
+ organization: *717
+ projects_v2_status_update: &764
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: *767
- required: *768
+ properties: *762
+ required: *763
sender: *4
required:
- action
@@ -153776,9 +153108,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *721
- organization: *722
- projects_v2_status_update: *769
+ installation: *716
+ organization: *717
+ projects_v2_status_update: *764
sender: *4
required:
- action
@@ -153914,9 +153246,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *721
- organization: *722
- projects_v2_status_update: *769
+ installation: *716
+ organization: *717
+ projects_v2_status_update: *764
sender: *4
required:
- action
@@ -153987,10 +153319,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- repository
@@ -154067,13 +153399,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *740
- enterprise: *720
- installation: *721
- number: &770
+ assignee: *735
+ enterprise: *715
+ installation: *716
+ number: &765
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -156356,7 +155688,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -156438,11 +155770,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -158720,7 +158052,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -158802,11 +158134,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -161084,7 +160416,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -161166,13 +160498,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: &771
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: &766
allOf:
- - *576
+ - *573
- type: object
properties:
allow_auto_merge:
@@ -161234,7 +160566,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -161315,12 +160647,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -161400,11 +160732,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *720
- milestone: *558
- number: *770
- organization: *722
- pull_request: &772
+ enterprise: *715
+ milestone: *555
+ number: *765
+ organization: *717
+ pull_request: &767
title: Pull Request
type: object
properties:
@@ -163667,7 +162999,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -163746,11 +163078,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -166032,7 +165364,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -166156,12 +165488,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -166241,11 +165573,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -168512,7 +167844,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -168592,11 +167924,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *720
- installation: *721
- label: *739
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ label: *734
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -170878,7 +170210,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -170959,10 +170291,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -173242,7 +172574,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -173322,12 +172654,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *720
- milestone: *558
- number: *770
- organization: *722
- pull_request: *772
- repository: *723
+ enterprise: *715
+ milestone: *555
+ number: *765
+ organization: *717
+ pull_request: *767
+ repository: *718
sender: *4
required:
- action
@@ -173406,12 +172738,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -173492,12 +172824,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -173577,12 +172909,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -173948,9 +173280,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
type: object
properties:
@@ -176120,7 +175452,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -176200,7 +175532,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &774
+ comment: &769
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -176485,9 +175817,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
type: object
properties:
@@ -178645,7 +177977,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -178725,11 +178057,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *773
- comment: *774
- enterprise: *720
- installation: *721
- organization: *722
+ changes: *768
+ comment: *769
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
type: object
properties:
@@ -180890,7 +180222,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -180971,9 +180303,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -183146,7 +182478,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
+ repository: *718
review:
description: The review that was affected.
type: object
@@ -183393,9 +182725,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -185449,8 +184781,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
- review: &775
+ repository: *718
+ review: &770
description: The review that was affected.
type: object
properties:
@@ -185683,12 +185015,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -187971,7 +187303,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
requested_reviewer:
title: User
type: object
@@ -188055,12 +187387,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -190350,7 +189682,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -190542,12 +189874,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -192832,7 +192164,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
requested_reviewer:
title: User
type: object
@@ -192917,12 +192249,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -195198,7 +194530,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -195379,9 +194711,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -197556,8 +196888,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
- review: *775
+ repository: *718
+ review: *770
sender: *4
required:
- action
@@ -197637,9 +196969,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -199709,7 +199041,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
thread:
type: object
@@ -200096,9 +199428,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -202154,7 +201486,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
thread:
type: object
@@ -202544,10 +201876,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -204818,7 +204150,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -204900,11 +204232,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *776
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
+ assignee: *771
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -207187,7 +206519,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -207266,11 +206598,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *720
- installation: *721
- label: *739
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ label: *734
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -209543,7 +208875,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -209624,10 +208956,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -211892,7 +211224,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -212092,7 +211424,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *720
+ enterprise: *715
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -212184,8 +211516,8 @@ x-webhooks:
- url
- author
- committer
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -212760,9 +212092,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
registry_package:
type: object
properties:
@@ -213208,7 +212540,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *757
+ items: *752
summary:
type: string
tag_name:
@@ -213262,7 +212594,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -213340,9 +212672,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
registry_package:
type: object
properties:
@@ -213650,7 +212982,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *757
+ items: *752
summary:
type: string
tag_name:
@@ -213699,7 +213031,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -213776,10 +213108,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- release: &777
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: &772
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -214097,7 +213429,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -214174,11 +213506,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- release: *777
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: *772
+ repository: *718
sender: *4
required:
- action
@@ -214295,11 +213627,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *720
- installation: *721
- organization: *722
- release: *777
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: *772
+ repository: *718
sender: *4
required:
- action
@@ -214377,9 +213709,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -214701,7 +214033,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -214777,10 +214109,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
- release: &778
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: &773
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -215099,7 +214431,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -215175,11 +214507,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *720
- installation: *721
- organization: *722
- release: *777
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: *772
+ repository: *718
sender: *4
required:
- action
@@ -215255,11 +214587,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *720
- installation: *721
- organization: *722
- release: *778
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: *773
+ repository: *718
sender: *4
required:
- action
@@ -215335,11 +214667,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- repository_advisory: *640
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ repository_advisory: *637
sender: *4
required:
- action
@@ -215415,11 +214747,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- repository_advisory: *640
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ repository_advisory: *637
sender: *4
required:
- action
@@ -215495,10 +214827,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215575,10 +214907,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215656,10 +214988,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215743,10 +215075,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215858,10 +215190,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215933,10 +215265,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
status:
type: string
@@ -216017,10 +215349,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216097,10 +215429,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216194,10 +215526,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216277,10 +215609,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
repository_ruleset: *307
sender: *4
required:
@@ -216359,10 +215691,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
repository_ruleset: *307
sender: *4
required:
@@ -216441,10 +215773,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
repository_ruleset: *307
changes:
type: object
@@ -216506,16 +215838,16 @@ x-webhooks:
properties:
added:
type: array
- items: *596
+ items: *593
deleted:
type: array
- items: *596
+ items: *593
updated:
type: array
items:
type: object
properties:
- rule: *596
+ rule: *593
changes:
type: object
properties:
@@ -216749,10 +216081,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216830,10 +216162,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216911,7 +216243,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &779
+ alert: &774
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -217032,10 +216364,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217241,10 +216573,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217322,11 +216654,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *779
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *774
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217525,10 +216857,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217606,7 +216938,7 @@ x-webhooks:
type: string
enum:
- assigned
- alert: &780
+ alert: &775
type: object
properties:
number: *170
@@ -217725,10 +217057,10 @@ x-webhooks:
required: *21
nullable: true
assignee: *4
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217806,11 +217138,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217891,11 +217223,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *780
- installation: *721
- location: *781
- organization: *722
- repository: *723
+ alert: *775
+ installation: *716
+ location: *776
+ organization: *717
+ repository: *718
sender: *4
required:
- location
@@ -218133,11 +217465,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218215,11 +217547,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218297,11 +217629,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218379,12 +217711,12 @@ x-webhooks:
type: string
enum:
- unassigned
- alert: *780
+ alert: *775
assignee: *4
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218462,11 +217794,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218592,10 +217924,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *723
- enterprise: *720
- installation: *721
- organization: *722
+ repository: *718
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -218673,11 +218005,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- security_advisory: &782
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ security_advisory: &777
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -218860,11 +218192,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- security_advisory: *782
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ security_advisory: *777
sender: *4
required:
- action
@@ -218937,10 +218269,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -219125,10 +218457,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *280
- enterprise: *720
- installation: *721
- organization: *722
- repository: *330
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *327
sender: *4
required:
- changes
@@ -219206,12 +218538,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: &783
+ sponsorship: &778
type: object
properties:
created_at:
@@ -219512,12 +218844,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- sponsorship
@@ -219605,12 +218937,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- changes
@@ -219687,17 +219019,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &784
+ effective_date: &779
description: The `pending_cancellation` and `pending_tier_change`
event types will include the date the cancellation or tier change
will take effect.
type: string
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- sponsorship
@@ -219771,7 +219103,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &785
+ changes: &780
type: object
properties:
tier:
@@ -219815,13 +219147,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *784
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ effective_date: *779
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- changes
@@ -219898,13 +219230,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *785
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ changes: *780
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- changes
@@ -219978,10 +219310,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -220064,10 +219396,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -220487,15 +219819,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *720
+ enterprise: *715
id:
description: The unique identifier of the status.
type: integer
- installation: *721
+ installation: *716
name:
type: string
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
sha:
description: The Commit SHA.
@@ -220610,9 +219942,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -220702,9 +220034,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -220794,9 +220126,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -220886,9 +220218,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -220965,12 +220297,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- team: &786
+ team: &781
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -221193,9 +220525,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -221653,7 +220985,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- team
@@ -221729,9 +221061,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -222189,7 +221521,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- team
@@ -222266,9 +221598,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -222726,7 +222058,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- team
@@ -222870,9 +222202,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -223330,7 +222662,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- changes
@@ -223408,9 +222740,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -223868,7 +223200,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- team
@@ -223944,10 +223276,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -224020,16 +223352,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *720
+ enterprise: *715
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
ref:
type: string
- repository: *723
+ repository: *718
sender: *4
workflow:
type: string
@@ -224111,10 +223443,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
workflow_job:
allOf:
@@ -224351,7 +223683,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *488
+ deployment: *485
required:
- action
- repository
@@ -224430,10 +223762,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
workflow_job:
allOf:
@@ -224693,7 +224025,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *488
+ deployment: *485
required:
- action
- repository
@@ -224772,10 +224104,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
workflow_job:
type: object
@@ -224910,7 +224242,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *488
+ deployment: *485
required:
- action
- repository
@@ -224989,10 +224321,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
workflow_job:
type: object
@@ -225128,7 +224460,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *488
+ deployment: *485
required:
- action
- repository
@@ -225208,12 +224540,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: *735
+ workflow: *730
workflow_run:
title: Workflow Run
type: object
@@ -226212,12 +225544,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: *735
+ workflow: *730
workflow_run:
title: Workflow Run
type: object
@@ -227201,12 +226533,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: *735
+ workflow: *730
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json
index b577e364b..da590311b 100644
--- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json
+++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json
@@ -199229,17 +199229,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
+ "/orgs/{org}/teams/{team_slug}/invitations": {
"get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussions-in-org",
+ "operationId": "teams/list-pending-invitations-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions"
+ "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
},
"parameters": [
{
@@ -199260,20 +199260,6 @@
"type": "string"
}
},
- {
- "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).\"",
@@ -199291,15 +199277,6 @@
"type": "integer",
"default": 1
}
- },
- {
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
- "schema": {
- "type": "string"
- }
}
],
"responses": {
@@ -199310,11 +199287,37 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -199436,143 +199439,34 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ ]
},
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
+ "team_count": {
"type": "integer"
},
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
+ "node_id": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
},
- "updated_at": {
+ "invitation_teams_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
},
- "url": {
+ "invitation_source": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/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"
- ]
+ "example": "\"member\""
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
+ "id",
+ "login",
+ "email",
+ "role",
"created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
]
}
},
@@ -199580,52 +199474,37 @@
"default": {
"value": [
{
- "author": {
- "login": "octocat",
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
"gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
"type": "User",
"site_admin": false
},
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
}
]
}
@@ -199646,19 +199525,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
}
- },
- "post": {
- "summary": "Create a discussion",
- "description": "Creates 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\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-in-org",
+ "operationId": "teams/list-members-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion"
+ "url": "https://docs.github.com/rest/teams/members#list-team-members"
},
"parameters": [
{
@@ -199678,320 +199559,177 @@
"schema": {
"type": "string"
}
- }
- ],
- "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."
- }
- }
- }
+ },
+ {
+ "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": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
+ "email": {
+ "nullable": true,
+ "type": "string"
},
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ }
},
"examples": {
"default": {
- "value": {
- "author": {
+ "value": [
+ {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -200010,60 +199748,41 @@
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
}
- }
+ ]
}
}
}
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
}
}
},
"x-github": {
- "triggersNotification": true,
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
"get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
"tags": [
"teams"
],
- "operationId": "teams/get-discussion-in-org",
+ "operationId": "teams/get-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion"
+ "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
},
"parameters": [
{
@@ -200085,12 +199804,12 @@
}
},
{
- "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"
}
}
],
@@ -200100,344 +199819,73 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
+ "url": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
+ "format": "uri"
},
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/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"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
"value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "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": "discussions"
+ "subcategory": "members"
}
},
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-in-org",
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion"
+ "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -200459,12 +199907,12 @@
}
},
{
- "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"
}
}
],
@@ -200475,20 +199923,22 @@
"schema": {
"type": "object",
"properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
+ "role": {
"type": "string",
- "description": "The discussion post's body text."
+ "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": {
- "title": "Welcome to our first team post"
+ "role": "maintainer"
}
}
}
@@ -200501,1111 +199951,8 @@
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/invitations": {
- "get": {
- "summary": "List pending team invitations",
- "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-pending-invitations-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Organization Invitation",
- "description": "Organization Invitation",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "login": {
- "type": "string",
- "nullable": true
- },
- "email": {
- "type": "string",
- "nullable": true
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "failed_at": {
- "type": "string",
- "nullable": true
- },
- "failed_reason": {
- "type": "string",
- "nullable": true
- },
- "inviter": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "team_count": {
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
- },
- "invitation_teams_url": {
- "type": "string",
- "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
- },
- "invitation_source": {
- "type": "string",
- "example": "\"member\""
- }
- },
- "required": [
- "id",
- "login",
- "email",
- "role",
- "created_at",
- "inviter",
- "team_count",
- "invitation_teams_url",
- "node_id"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "id": 1,
- "login": "monalisa",
- "node_id": "MDQ6VXNlcjE=",
- "email": "octocat@github.com",
- "role": "direct_member",
- "created_at": "2016-11-30T06:46:10-08:00",
- "failed_at": "",
- "failed_reason": "",
- "inviter": {
- "login": "other_user",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/other_user_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/other_user",
- "html_url": "https://github.com/other_user",
- "followers_url": "https://api.github.com/users/other_user/followers",
- "following_url": "https://api.github.com/users/other_user/following{/other_user}",
- "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
- "organizations_url": "https://api.github.com/users/other_user/orgs",
- "repos_url": "https://api.github.com/users/other_user/repos",
- "events_url": "https://api.github.com/users/other_user/events{/privacy}",
- "received_events_url": "https://api.github.com/users/other_user/received_events",
- "type": "User",
- "site_admin": false
- },
- "team_count": 2,
- "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
- "invitation_source": "member"
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/members": {
- "get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-members-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#list-team-members"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
"url": {
@@ -527688,1620 +526035,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- },
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
- }
- },
- "required": [
- "title",
- "body"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
- }
- }
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
index 5668f0183..8c8220213 100644
--- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
+++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
@@ -1021,7 +1021,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &642
+ - &639
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -8796,7 +8796,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
- - &478
+ - &475
name: has
in: query
description: |-
@@ -8912,7 +8912,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &479
+ security_advisory: &476
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -9174,14 +9174,14 @@ paths:
format: date-time
readOnly: true
nullable: true
- auto_dismissed_at: &480
+ auto_dismissed_at: &477
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &481
+ dismissal_request: &478
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -10543,7 +10543,7 @@ paths:
properties:
action:
type: string
- discussion: &736
+ discussion: &731
title: Discussion
description: A Discussion in a repository.
type: object
@@ -10910,7 +10910,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &532
+ properties: &529
id:
type: integer
format: int64
@@ -11287,7 +11287,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &654
+ sub_issues_summary: &651
title: Sub-issues Summary
type: object
properties:
@@ -11307,7 +11307,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &655
+ issue_dependencies_summary: &652
title: Issue Dependencies Summary
type: object
properties:
@@ -11326,7 +11326,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &656
+ items: &653
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -11387,7 +11387,7 @@ paths:
- node_id
- data_type
- value
- required: &533
+ required: &530
- assignee
- closed_at
- comments
@@ -11425,7 +11425,7 @@ paths:
action:
type: string
issue: *75
- comment: &528
+ comment: &525
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -12144,7 +12144,7 @@ paths:
type: string
release:
allOf:
- - &587
+ - &584
title: Release
description: A release.
type: object
@@ -12215,7 +12215,7 @@ paths:
author: *4
assets:
type: array
- items: &588
+ items: &585
title: Release Asset
description: Data related to a release.
type: object
@@ -12806,7 +12806,7 @@ paths:
url:
type: string
format: uri
- user: &664
+ user: &659
title: Public User
description: Public User
type: object
@@ -16111,14 +16111,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &327
+ - &324
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &328
+ - &325
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -16180,7 +16180,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &331
+ '301': &328
description: Moved permanently
content:
application/json:
@@ -16202,7 +16202,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &561
+ - &558
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -16210,7 +16210,7 @@ paths:
schema:
type: boolean
default: false
- - &562
+ - &559
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -16220,7 +16220,7 @@ paths:
type: boolean
default: false
- *82
- - &563
+ - &560
name: before
description: 'Only show notifications updated before the given time. This
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
@@ -16694,7 +16694,7 @@ paths:
- url
- subscription_url
examples:
- default: &564
+ default: &561
value:
- id: '1'
repository:
@@ -17708,7 +17708,7 @@ paths:
- property_name
- value
examples:
- default: &570
+ default: &567
value:
- property_name: environment
value: production
@@ -17758,7 +17758,7 @@ paths:
required:
- properties
examples:
- default: &571
+ default: &568
value:
properties:
- property_name: environment
@@ -18319,7 +18319,7 @@ paths:
required: false
schema:
type: string
- - &713
+ - &708
name: model
description: The model name to query usage for. The name is not case sensitive.
in: query
@@ -18465,7 +18465,7 @@ paths:
parameters:
- *68
- *115
- - &714
+ - &709
name: month
description: If specified, only return results for a single month. The value
of `month` is an integer between `1` and `12`. If no year is specified the
@@ -18577,7 +18577,7 @@ paths:
- *115
- *117
- *116
- - &715
+ - &710
name: repository
description: The repository name to query for usage in the format owner/repository.
in: query
@@ -18585,7 +18585,7 @@ paths:
schema:
type: string
- *118
- - &716
+ - &711
name: sku
description: The SKU to query for usage.
in: query
@@ -19487,7 +19487,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &338
+ items: &335
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -20679,7 +20679,7 @@ paths:
- all
- local_only
- selected
- selected_actions_url: &344
+ selected_actions_url: &341
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`
@@ -20762,7 +20762,7 @@ paths:
description: Response
content:
application/json:
- schema: &348
+ schema: &345
type: object
properties:
days:
@@ -20804,7 +20804,7 @@ paths:
required: true
content:
application/json:
- schema: &349
+ schema: &346
type: object
properties:
days:
@@ -20861,7 +20861,7 @@ paths:
required:
- approval_policy
examples:
- default: &350
+ default: &347
value:
approval_policy: first_time_contributors
'404': *6
@@ -20920,7 +20920,7 @@ paths:
description: Response
content:
application/json:
- schema: &351
+ schema: &348
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -20974,7 +20974,7 @@ paths:
required: true
content:
application/json:
- schema: &352
+ schema: &349
type: object
required:
- run_workflows_from_fork_pull_requests
@@ -21609,7 +21609,7 @@ paths:
description: Response
content:
application/json:
- schema: &353
+ schema: &350
type: object
properties:
default_workflow_permissions: &145
@@ -21660,7 +21660,7 @@ paths:
required: false
content:
application/json:
- schema: &354
+ schema: &351
type: object
properties:
default_workflow_permissions: *145
@@ -22149,7 +22149,7 @@ paths:
type: array
items: *152
examples:
- default: &667
+ default: &662
value:
total_count: 1
repositories:
@@ -22791,7 +22791,7 @@ paths:
application/json:
schema:
type: array
- items: &355
+ items: &352
title: Runner Application
description: Runner Application
type: object
@@ -22816,7 +22816,7 @@ paths:
- download_url
- filename
examples:
- default: &356
+ default: &353
value:
- os: osx
architecture: x64
@@ -22902,7 +22902,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': &357
+ '201': &354
description: Response
content:
application/json:
@@ -23013,7 +23013,7 @@ paths:
- token
- expires_at
examples:
- default: &358
+ default: &355
value:
token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-22T12:13:35.123-08:00'
@@ -23052,7 +23052,7 @@ paths:
application/json:
schema: *156
examples:
- default: &359
+ default: &356
value:
token: AABF3JGZDX3P5PMEXLND6TS6FCWO6
expires_at: '2020-01-29T12:13:35.123-08:00'
@@ -23086,7 +23086,7 @@ paths:
application/json:
schema: *154
examples:
- default: &360
+ default: &357
value:
id: 23
name: MBP
@@ -23312,7 +23312,7 @@ paths:
- *68
- *153
responses:
- '200': &361
+ '200': &358
description: Response
content:
application/json:
@@ -23369,7 +23369,7 @@ paths:
parameters:
- *68
- *153
- - &362
+ - &359
name: name
description: The name of a self-hosted runner's custom label.
in: path
@@ -23499,7 +23499,7 @@ paths:
description: Response
content:
application/json:
- schema: &374
+ schema: &371
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -23528,7 +23528,7 @@ paths:
- key_id
- key
examples:
- default: &375
+ default: &372
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -23941,7 +23941,7 @@ paths:
url: https://docs.github.com/rest/actions/variables#list-organization-variables
parameters:
- *68
- - &343
+ - &340
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)."
@@ -25078,12 +25078,12 @@ paths:
required:
- subject_digests
examples:
- default: &695
+ default: &690
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &696
+ withPredicateType: &691
value:
subject_digests:
- sha256:abc123
@@ -25141,7 +25141,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &697
+ default: &692
value:
attestations_subject_digests:
- sha256:abc:
@@ -25490,7 +25490,7 @@ paths:
initiator:
type: string
examples:
- default: &388
+ default: &385
value:
attestations:
- bundle:
@@ -26419,7 +26419,7 @@ paths:
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
parameters:
- *68
- - &413
+ - &410
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`,
@@ -26429,7 +26429,7 @@ paths:
schema: &177
type: string
description: The name of the tool used to generate the code scanning analysis.
- - &414
+ - &411
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
@@ -26452,7 +26452,7 @@ paths:
be returned.
in: query
required: false
- schema: &416
+ schema: &413
type: string
description: State of a code scanning alert.
enum:
@@ -26475,7 +26475,7 @@ paths:
be returned.
in: query
required: false
- schema: &417
+ schema: &414
type: string
description: Severity of a code scanning alert.
enum:
@@ -26509,7 +26509,7 @@ paths:
updated_at: *172
url: *173
html_url: *174
- instances_url: &418
+ instances_url: &415
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -26532,7 +26532,7 @@ paths:
required: *21
nullable: true
dismissed_at: *176
- dismissed_reason: &419
+ dismissed_reason: &416
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -26541,13 +26541,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &420
+ dismissed_comment: &417
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &421
+ rule: &418
type: object
properties:
id:
@@ -26600,7 +26600,7 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &422
+ tool: &419
type: object
properties:
name: *177
@@ -26610,26 +26610,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *178
- most_recent_instance: &423
+ most_recent_instance: &420
type: object
properties:
- ref: &415
+ ref: &412
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &433
+ analysis_key: &430
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: &434
+ environment: &431
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: &435
+ category: &432
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -26643,7 +26643,7 @@ paths:
properties:
text:
type: string
- location: &436
+ location: &433
type: object
description: Describe a region within a file for the alert.
properties:
@@ -26664,7 +26664,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: &437
+ items: &434
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -27954,7 +27954,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &449
+ properties: &446
name:
type: string
description: The name of the machine.
@@ -27996,7 +27996,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &450
+ required: &447
- name
- display_name
- operating_system
@@ -28864,7 +28864,7 @@ paths:
- updated_at
- visibility
examples:
- default: &451
+ default: &448
value:
total_count: 2
secrets:
@@ -28902,7 +28902,7 @@ paths:
description: Response
content:
application/json:
- schema: &452
+ schema: &449
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -28931,7 +28931,7 @@ paths:
- key_id
- key
examples:
- default: &453
+ default: &450
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -28963,7 +28963,7 @@ paths:
application/json:
schema: *186
examples:
- default: &455
+ default: &452
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -30576,7 +30576,7 @@ paths:
description: Response
content:
application/json:
- schema: &484
+ schema: &481
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -30593,7 +30593,7 @@ paths:
- key_id
- key
examples:
- default: &485
+ default: &482
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -32393,7 +32393,7 @@ paths:
application/json:
schema: *22
examples:
- default: &523
+ default: &520
value:
id: 1
account:
@@ -32618,7 +32618,7 @@ paths:
required: true
content:
application/json:
- schema: &524
+ schema: &521
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -33471,7 +33471,7 @@ paths:
application/json:
schema: *232
examples:
- default: &448
+ default: &445
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -34720,7 +34720,7 @@ paths:
parameters:
- *68
- *239
- - &680
+ - &675
name: repo_name
description: repo_name parameter
in: path
@@ -35759,7 +35759,7 @@ paths:
- nuget
- container
- *68
- - &681
+ - &676
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -35800,7 +35800,7 @@ paths:
default: *246
'403': *29
'401': *25
- '400': &683
+ '400': &678
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -37592,7 +37592,7 @@ paths:
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: &767
+ properties: &762
id:
type: number
description: The unique identifier of the status update.
@@ -37640,7 +37640,7 @@ paths:
example: The project is off to a great start!
type: string
nullable: true
- required: &768
+ required: &763
- id
- node_id
- created_at
@@ -37854,7 +37854,7 @@ paths:
content:
oneOf:
- *75
- - &465
+ - &462
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -38083,7 +38083,7 @@ paths:
- review_comment
- self
author_association: *76
- auto_merge: &573
+ auto_merge: &570
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -38458,7 +38458,7 @@ paths:
- updated_at
- project_url
examples:
- default: &700
+ default: &695
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -38635,7 +38635,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &701
+ items: &696
type: object
properties:
name:
@@ -38671,7 +38671,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &702
+ iteration_configuration: &697
type: object
description: The configuration for iteration fields.
properties:
@@ -38720,7 +38720,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &703
+ single_select_field: &698
summary: Create a single select field
value:
name: Priority
@@ -38747,7 +38747,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &704
+ iteration_field: &699
summary: Create an iteration field
value:
name: Sprint
@@ -38773,7 +38773,7 @@ paths:
application/json:
schema: *267
examples:
- text_field: &705
+ text_field: &700
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -38782,7 +38782,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-05-15T08:00:00Z'
updated_at: '2022-05-15T08:00:00Z'
- number_field: &706
+ number_field: &701
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -38791,7 +38791,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-01T14:30:00Z'
updated_at: '2022-06-01T14:30:00Z'
- date_field: &707
+ date_field: &702
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -38800,7 +38800,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-10T09:15:00Z'
updated_at: '2022-06-10T09:15:00Z'
- single_select_field: &708
+ single_select_field: &703
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -38834,7 +38834,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &709
+ iteration_field: &704
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -38880,7 +38880,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization
parameters:
- *263
- - &710
+ - &705
name: field_id
description: The unique identifier of the field.
in: path
@@ -38895,7 +38895,7 @@ paths:
application/json:
schema: *267
examples:
- default: &711
+ default: &706
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -40021,7 +40021,7 @@ paths:
parameters:
- *263
- *68
- - &712
+ - &707
name: view_number
description: The number that identifies the project view.
in: path
@@ -40933,7 +40933,7 @@ paths:
description: Response
content:
application/json:
- schema: &330
+ schema: &327
title: Full Repository
description: Full Repository
type: object
@@ -41326,7 +41326,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &470
+ properties: &467
url:
type: string
format: uri
@@ -41342,7 +41342,7 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &471
+ required: &468
- url
- key
- name
@@ -41431,7 +41431,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &332
+ default: &329
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -41952,7 +41952,7 @@ paths:
- *68
- *17
- *19
- - &595
+ - &592
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -42233,7 +42233,7 @@ paths:
- repository_property
rules:
type: array
- items: &596
+ items: &593
title: Repository Rule
type: object
description: A repository rule.
@@ -42295,7 +42295,7 @@ paths:
type: string
enum:
- required_linear_history
- - &594
+ - &591
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -43191,7 +43191,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *68
- - &597
+ - &594
name: ref
description: The name of the ref. Cannot contain wildcard characters. Optionally
prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit
@@ -43206,7 +43206,7 @@ paths:
in: query
schema:
type: string
- - &598
+ - &595
name: time_period
description: |-
The time period to filter by.
@@ -43222,14 +43222,14 @@ paths:
- week
- month
default: day
- - &599
+ - &596
name: actor_name
description: The handle for the GitHub user account to filter on. When specified,
only rule evaluations triggered by this actor will be returned.
in: query
schema:
type: string
- - &600
+ - &597
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -43249,7 +43249,7 @@ paths:
description: Response
content:
application/json:
- schema: &601
+ schema: &598
title: Rule Suites
description: Response
type: array
@@ -43304,7 +43304,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &602
+ default: &599
value:
- id: 21
actor_id: 12
@@ -43348,7 +43348,7 @@ paths:
url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *68
- - &603
+ - &600
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -43364,7 +43364,7 @@ paths:
description: Response
content:
application/json:
- schema: &604
+ schema: &601
title: Rule Suite
description: Response
type: object
@@ -43463,7 +43463,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &605
+ default: &602
value:
id: 21
actor_id: 12
@@ -43709,7 +43709,7 @@ paths:
type: string
format: date-time
examples:
- default: &607
+ default: &604
value:
- version_id: 3
actor:
@@ -43762,7 +43762,7 @@ paths:
description: Response
content:
application/json:
- schema: &608
+ schema: &605
allOf:
- *310
- type: object
@@ -43834,7 +43834,7 @@ paths:
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization
parameters:
- *68
- - &609
+ - &606
name: state
in: query
description: Set to `open` or `resolved` to only list secret scanning alerts
@@ -43845,7 +43845,7 @@ paths:
enum:
- open
- resolved
- - &610
+ - &607
name: secret_type
in: query
description: A comma-separated list of secret types to return. All default
@@ -43855,7 +43855,7 @@ paths:
required: false
schema:
type: string
- - &611
+ - &608
name: resolution
in: query
description: A comma-separated list of resolutions. Only secret scanning alerts
@@ -43864,7 +43864,7 @@ paths:
required: false
schema:
type: string
- - &612
+ - &609
name: assignee
in: query
description: Filters alerts by assignee. Use `*` to get all assigned alerts,
@@ -43883,7 +43883,7 @@ paths:
all-unassigned:
value: none
summary: Filter for all unassigned alerts
- - &613
+ - &610
name: sort
description: The property to sort the results by. `created` means when the
alert was created. `updated` means when the alert was updated or resolved.
@@ -43898,7 +43898,7 @@ paths:
- *53
- *19
- *17
- - &614
+ - &611
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -43908,7 +43908,7 @@ paths:
required: false
schema:
type: string
- - &615
+ - &612
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -43918,7 +43918,7 @@ paths:
required: false
schema:
type: string
- - &616
+ - &613
name: validity
in: query
description: A comma-separated list of validities that, when present, will
@@ -43927,7 +43927,7 @@ paths:
required: false
schema:
type: string
- - &617
+ - &614
name: is_publicly_leaked
in: query
description: A boolean value representing whether or not to filter alerts
@@ -43936,7 +43936,7 @@ paths:
schema:
type: boolean
default: false
- - &618
+ - &615
name: is_multi_repo
in: query
description: A boolean value representing whether or not to filter alerts
@@ -43945,7 +43945,7 @@ paths:
schema:
type: boolean
default: false
- - &619
+ - &616
name: hide_secret
in: query
description: A boolean value representing whether or not to hide literal secrets
@@ -43980,14 +43980,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &620
+ state: &617
description: Sets the state of the secret scanning alert. You
must provide `resolution` when you set the state to `resolved`.
type: string
enum:
- open
- resolved
- resolution: &621
+ resolution: &618
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -44094,8 +44094,8 @@ paths:
pull request.
'
- oneOf: &622
- - &624
+ oneOf: &619
+ - &621
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -44147,7 +44147,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &625
+ - &622
description: Represents a 'wiki_commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository wiki.
@@ -44202,7 +44202,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &626
+ - &623
description: Represents an 'issue_title' secret scanning location
type. This location type shows that a secret was detected
in the title of an issue.
@@ -44216,7 +44216,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &627
+ - &624
description: Represents an 'issue_body' secret scanning location
type. This location type shows that a secret was detected
in the body of an issue.
@@ -44230,7 +44230,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &628
+ - &625
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on an issue.
@@ -44244,7 +44244,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &629
+ - &626
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a discussion.
@@ -44258,7 +44258,7 @@ paths:
example: https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &630
+ - &627
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a discussion.
@@ -44272,7 +44272,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &631
+ - &628
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a discussion.
@@ -44286,7 +44286,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &632
+ - &629
description: Represents a 'pull_request_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a pull request.
@@ -44300,7 +44300,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &633
+ - &630
description: Represents a 'pull_request_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a pull request.
@@ -44314,7 +44314,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &634
+ - &631
description: Represents a 'pull_request_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a pull request.
@@ -44328,7 +44328,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &635
+ - &632
description: Represents a 'pull_request_review' secret scanning
location type. This location type shows that a secret was
detected in a review on a pull request.
@@ -44342,7 +44342,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &636
+ - &633
description: Represents a 'pull_request_review_comment' secret
scanning location type. This location type shows that a
secret was detected in a review comment on a pull request.
@@ -44840,7 +44840,7 @@ paths:
application/json:
schema:
type: array
- items: &640
+ items: &637
description: A repository security advisory.
type: object
properties:
@@ -45131,7 +45131,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &641
+ default: &638
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -46908,454 +46908,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#list-discussions
- parameters:
- - *68
- - *69
- - *53
- - *17
- - *19
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &323
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form
- conversation within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *20
- required: *21
- nullable: true
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a
- team
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned
- for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted
- to team members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions: *77
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
- examples:
- default: &658
- value:
- - author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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: *59
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#create-a-discussion
- parameters:
- - *68
- - *69
- 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: *323
- examples:
- default: &324
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Our first team post
- updated_at: '2018-01-25T18:56:31Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#get-a-discussion
- parameters:
- - *68
- - *69
- - &325
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *323
- examples:
- default: *324
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#update-a-discussion
- parameters:
- - *68
- - *69
- - *325
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *323
- examples:
- default: &659
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Welcome to our first team post
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#delete-a-discussion
- parameters:
- - *68
- - *69
- - *325
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/invitations":
get:
summary: List pending team invitations
@@ -47468,7 +47020,7 @@ paths:
description: Response
content:
application/json:
- schema: &326
+ schema: &323
title: Team Membership
description: Team Membership
type: object
@@ -47495,7 +47047,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &660
+ response-if-user-is-a-team-maintainer: &655
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -47558,9 +47110,9 @@ paths:
description: Response
content:
application/json:
- schema: *326
+ schema: *323
examples:
- response-if-users-membership-with-team-is-now-pending: &661
+ response-if-users-membership-with-team-is-now-pending: &656
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -47667,14 +47219,14 @@ paths:
parameters:
- *68
- *69
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &662
+ schema: &657
title: Team Repository
description: A team's access to a repository.
type: object
@@ -48245,8 +47797,8 @@ paths:
parameters:
- *68
- *69
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -48293,8 +47845,8 @@ paths:
parameters:
- *68
- *69
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -48331,7 +47883,7 @@ paths:
type: array
items: *189
examples:
- response-if-child-teams-exist: &663
+ response-if-child-teams-exist: &658
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -48485,7 +48037,7 @@ paths:
resources:
type: object
properties:
- core: &329
+ core: &326
title: Rate Limit
type: object
properties:
@@ -48502,21 +48054,21 @@ paths:
- remaining
- reset
- used
- graphql: *329
- search: *329
- code_search: *329
- source_import: *329
- integration_manifest: *329
- code_scanning_upload: *329
- actions_runner_registration: *329
- scim: *329
- dependency_snapshots: *329
- dependency_sbom: *329
- code_scanning_autofix: *329
+ graphql: *326
+ search: *326
+ code_search: *326
+ source_import: *326
+ integration_manifest: *326
+ code_scanning_upload: *326
+ actions_runner_registration: *326
+ scim: *326
+ dependency_snapshots: *326
+ dependency_sbom: *326
+ code_scanning_autofix: *326
required:
- core
- search
- rate: *329
+ rate: *326
required:
- rate
- resources
@@ -48621,14 +48173,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
default-response:
summary: Default response
@@ -49129,7 +48681,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *331
+ '301': *328
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -49147,8 +48699,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#update-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -49395,10 +48947,10 @@ paths:
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
- '307': &333
+ default: *329
+ '307': &330
description: Temporary Redirect
content:
application/json:
@@ -49427,8 +48979,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#delete-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -49450,7 +49002,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository
- '307': *333
+ '307': *330
'404': *6
'409': *52
x-github:
@@ -49474,11 +49026,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
- - &366
+ - &363
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -49501,7 +49053,7 @@ paths:
type: integer
artifacts:
type: array
- items: &334
+ items: &331
title: Artifact
description: An artifact
type: object
@@ -49579,7 +49131,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &367
+ default: &364
value:
total_count: 2
artifacts:
@@ -49640,9 +49192,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#get-an-artifact
parameters:
- - *327
- - *328
- - &335
+ - *324
+ - *325
+ - &332
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -49654,7 +49206,7 @@ paths:
description: Response
content:
application/json:
- schema: *334
+ schema: *331
examples:
default:
value:
@@ -49692,9 +49244,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact
parameters:
- - *327
- - *328
- - *335
+ - *324
+ - *325
+ - *332
responses:
'204':
description: Response
@@ -49718,9 +49270,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#download-an-artifact
parameters:
- - *327
- - *328
- - *335
+ - *324
+ - *325
+ - *332
- name: archive_format
in: path
required: true
@@ -49734,7 +49286,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': &527
+ '410': &524
description: Gone
content:
application/json:
@@ -49759,14 +49311,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &336
+ schema: &333
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -49799,13 +49351,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *336
+ schema: *333
examples:
selected_actions: *42
responses:
@@ -49834,14 +49386,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &337
+ schema: &334
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -49874,13 +49426,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *337
+ schema: *334
examples:
selected_actions: *44
responses:
@@ -49911,14 +49463,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *338
+ schema: *335
examples:
default:
value:
@@ -49944,11 +49496,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
- - &339
+ - &336
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
@@ -49982,7 +49534,7 @@ paths:
description: Response
content:
application/json:
- schema: &340
+ schema: &337
title: Repository actions caches
description: Repository actions caches
type: object
@@ -50024,7 +49576,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &341
+ default: &338
value:
total_count: 1
actions_caches:
@@ -50056,23 +49608,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:
- - *327
- - *328
+ - *324
+ - *325
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *339
+ - *336
responses:
'200':
description: Response
content:
application/json:
- schema: *340
+ schema: *337
examples:
- default: *341
+ default: *338
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -50092,8 +49644,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:
- - *327
- - *328
+ - *324
+ - *325
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -50124,9 +49676,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *327
- - *328
- - &342
+ - *324
+ - *325
+ - &339
name: job_id
description: The unique identifier of the job.
in: path
@@ -50138,7 +49690,7 @@ paths:
description: Response
content:
application/json:
- schema: &370
+ schema: &367
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -50445,9 +49997,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *327
- - *328
- - *342
+ - *324
+ - *325
+ - *339
responses:
'302':
description: Response
@@ -50475,9 +50027,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *327
- - *328
- - *342
+ - *324
+ - *325
+ - *339
requestBody:
required: false
content:
@@ -50522,8 +50074,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Status response
@@ -50573,8 +50125,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -50637,8 +50189,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -50656,7 +50208,7 @@ paths:
type: integer
secrets:
type: array
- items: &372
+ items: &369
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -50676,7 +50228,7 @@ paths:
- created_at
- updated_at
examples:
- default: &373
+ default: &370
value:
total_count: 2
secrets:
@@ -50709,9 +50261,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables
parameters:
- - *327
- - *328
- - *343
+ - *324
+ - *325
+ - *340
- *19
responses:
'200':
@@ -50728,7 +50280,7 @@ paths:
type: integer
variables:
type: array
- items: &376
+ items: &373
title: Actions Variable
type: object
properties:
@@ -50758,7 +50310,7 @@ paths:
- created_at
- updated_at
examples:
- default: &377
+ default: &374
value:
total_count: 2
variables:
@@ -50791,8 +50343,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -50801,11 +50353,11 @@ paths:
schema:
type: object
properties:
- enabled: &345
+ enabled: &342
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *137
- selected_actions_url: *344
+ selected_actions_url: *341
sha_pinning_required: *138
required:
- enabled
@@ -50834,8 +50386,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -50846,7 +50398,7 @@ paths:
schema:
type: object
properties:
- enabled: *345
+ enabled: *342
allowed_actions: *137
sha_pinning_required: *138
required:
@@ -50878,14 +50430,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &346
+ schema: &343
type: object
properties:
access_level:
@@ -50902,7 +50454,7 @@ paths:
required:
- access_level
examples:
- default: &347
+ default: &344
value:
access_level: organization
x-github:
@@ -50926,15 +50478,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *346
+ schema: *343
examples:
- default: *347
+ default: *344
responses:
'204':
description: Response
@@ -50958,14 +50510,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *348
+ schema: *345
examples:
default:
value:
@@ -50989,8 +50541,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Empty response for successful settings update
@@ -51000,7 +50552,7 @@ paths:
required: true
content:
application/json:
- schema: *349
+ schema: *346
examples:
default:
summary: Set retention days
@@ -51024,8 +50576,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -51033,7 +50585,7 @@ paths:
application/json:
schema: *139
examples:
- default: *350
+ default: *347
'404': *6
x-github:
enabledForGitHubApps: true
@@ -51052,8 +50604,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -51087,14 +50639,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *351
+ schema: *348
examples:
default: *140
'403': *29
@@ -51116,13 +50668,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *352
+ schema: *349
examples:
default: *140
responses:
@@ -51148,8 +50700,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -51176,8 +50728,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -51209,14 +50761,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *353
+ schema: *350
examples:
default: *147
x-github:
@@ -51239,8 +50791,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Success response
@@ -51251,7 +50803,7 @@ paths:
required: true
content:
application/json:
- schema: *354
+ schema: *351
examples:
default: *147
x-github:
@@ -51280,8 +50832,8 @@ paths:
in: query
schema:
type: string
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -51325,8 +50877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -51334,9 +50886,9 @@ paths:
application/json:
schema:
type: array
- items: *355
+ items: *352
examples:
- default: *356
+ default: *353
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51358,8 +50910,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -51402,7 +50954,7 @@ paths:
- no-gpu
work_folder: _work
responses:
- '201': *357
+ '201': *354
'404': *6
'422': *7
'409': *52
@@ -51433,8 +50985,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'201':
description: Response
@@ -51442,7 +50994,7 @@ paths:
application/json:
schema: *156
examples:
- default: *358
+ default: *355
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51470,8 +51022,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'201':
description: Response
@@ -51479,7 +51031,7 @@ paths:
application/json:
schema: *156
examples:
- default: *359
+ default: *356
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51501,8 +51053,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
responses:
'200':
@@ -51511,7 +51063,7 @@ paths:
application/json:
schema: *154
examples:
- default: *360
+ default: *357
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51532,8 +51084,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
responses:
'204':
@@ -51560,8 +51112,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
responses:
'200': *158
@@ -51586,8 +51138,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
requestBody:
required: true
@@ -51636,8 +51188,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
requestBody:
required: true
@@ -51687,11 +51239,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
responses:
- '200': *361
+ '200': *358
'404': *6
x-github:
githubCloudOnly: false
@@ -51718,10 +51270,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:
- - *327
- - *328
+ - *324
+ - *325
- *153
- - *362
+ - *359
responses:
'200': *158
'404': *6
@@ -51749,9 +51301,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *327
- - *328
- - &380
+ - *324
+ - *325
+ - &377
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.
@@ -51759,7 +51311,7 @@ paths:
required: false
schema:
type: string
- - &381
+ - &378
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -51767,7 +51319,7 @@ paths:
required: false
schema:
type: string
- - &382
+ - &379
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -51776,7 +51328,7 @@ paths:
required: false
schema:
type: string
- - &383
+ - &380
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
@@ -51803,7 +51355,7 @@ paths:
- pending
- *17
- *19
- - &384
+ - &381
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)."
@@ -51812,7 +51364,7 @@ paths:
schema:
type: string
format: date-time
- - &363
+ - &360
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -51821,13 +51373,13 @@ paths:
schema:
type: boolean
default: false
- - &385
+ - &382
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &386
+ - &383
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -51850,7 +51402,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &364
+ items: &361
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -51998,7 +51550,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &408
+ properties: &405
id:
type: string
description: SHA for the commit
@@ -52049,7 +51601,7 @@ paths:
- name
- email
nullable: true
- required: &409
+ required: &406
- id
- tree_id
- message
@@ -52096,7 +51648,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &387
+ default: &384
value:
total_count: 1
workflow_runs:
@@ -52332,24 +51884,24 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *327
- - *328
- - &365
+ - *324
+ - *325
+ - &362
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *363
+ - *360
responses:
'200':
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: &368
+ default: &365
value:
id: 30433642
name: Build
@@ -52590,9 +52142,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'204':
description: Response
@@ -52615,9 +52167,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'200':
description: Response
@@ -52736,9 +52288,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:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'201':
description: Response
@@ -52771,12 +52323,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
- *17
- *19
- - *366
+ - *363
responses:
'200':
description: Response
@@ -52792,9 +52344,9 @@ paths:
type: integer
artifacts:
type: array
- items: *334
+ items: *331
examples:
- default: *367
+ default: *364
headers:
Link: *59
x-github:
@@ -52818,25 +52370,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *327
- - *328
- - *365
- - &369
+ - *324
+ - *325
+ - *362
+ - &366
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *363
+ - *360
responses:
'200':
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: *368
+ default: *365
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52859,10 +52411,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *327
- - *328
- - *365
- - *369
+ - *324
+ - *325
+ - *362
+ - *366
- *17
- *19
responses:
@@ -52880,9 +52432,9 @@ paths:
type: integer
jobs:
type: array
- items: *370
+ items: *367
examples:
- default: &371
+ default: &368
value:
total_count: 1
jobs:
@@ -52995,10 +52547,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *327
- - *328
- - *365
- - *369
+ - *324
+ - *325
+ - *362
+ - *366
responses:
'302':
description: Response
@@ -53026,9 +52578,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'202':
description: Response
@@ -53061,9 +52613,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:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
requestBody:
required: true
content:
@@ -53130,9 +52682,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'202':
description: Response
@@ -53165,9 +52717,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
- 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
@@ -53197,9 +52749,9 @@ paths:
type: integer
jobs:
type: array
- items: *370
+ items: *367
examples:
- default: *371
+ default: *368
headers:
Link: *59
x-github:
@@ -53224,9 +52776,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'302':
description: Response
@@ -53253,9 +52805,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'204':
description: Response
@@ -53282,9 +52834,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'200':
description: Response
@@ -53344,7 +52896,7 @@ paths:
items:
type: object
properties:
- type: &493
+ type: &490
type: string
description: The type of reviewer.
enum:
@@ -53429,9 +52981,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
requestBody:
required: true
content:
@@ -53478,7 +53030,7 @@ paths:
application/json:
schema:
type: array
- items: &488
+ items: &485
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -53584,7 +53136,7 @@ paths:
- created_at
- updated_at
examples:
- default: &489
+ default: &486
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -53640,9 +53192,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
requestBody:
required: false
content:
@@ -53686,9 +53238,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
requestBody:
required: false
content:
@@ -53741,9 +53293,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *327
- - *328
- - *365
+ - *324
+ - *325
+ - *362
responses:
'200':
description: Response
@@ -53880,8 +53432,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-repository-secrets
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -53899,9 +53451,9 @@ paths:
type: integer
secrets:
type: array
- items: *372
+ items: *369
examples:
- default: *373
+ default: *370
headers:
Link: *59
x-github:
@@ -53926,16 +53478,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *374
+ schema: *371
examples:
- default: *375
+ default: *372
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -53957,17 +53509,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'200':
description: Response
content:
application/json:
- schema: *372
+ schema: *369
examples:
- default: &506
+ default: &503
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -53993,8 +53545,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
requestBody:
required: true
@@ -54052,8 +53604,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'204':
@@ -54079,9 +53631,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-repository-variables
parameters:
- - *327
- - *328
- - *343
+ - *324
+ - *325
+ - *340
- *19
responses:
'200':
@@ -54098,9 +53650,9 @@ paths:
type: integer
variables:
type: array
- items: *376
+ items: *373
examples:
- default: *377
+ default: *374
headers:
Link: *59
x-github:
@@ -54123,8 +53675,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-a-repository-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -54176,17 +53728,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-a-repository-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
responses:
'200':
description: Response
content:
application/json:
- schema: *376
+ schema: *373
examples:
- default: &507
+ default: &504
value:
name: USERNAME
value: octocat
@@ -54212,8 +53764,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-a-repository-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
requestBody:
required: true
@@ -54256,8 +53808,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
responses:
'204':
@@ -54283,8 +53835,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#list-repository-workflows
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -54302,7 +53854,7 @@ paths:
type: integer
workflows:
type: array
- items: &378
+ items: &375
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -54409,9 +53961,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-a-workflow
parameters:
- - *327
- - *328
- - &379
+ - *324
+ - *325
+ - &376
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -54426,7 +53978,7 @@ paths:
description: Response
content:
application/json:
- schema: *378
+ schema: *375
examples:
default:
value:
@@ -54459,9 +54011,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#disable-a-workflow
parameters:
- - *327
- - *328
- - *379
+ - *324
+ - *325
+ - *376
responses:
'204':
description: Response
@@ -54486,9 +54038,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *327
- - *328
- - *379
+ - *324
+ - *325
+ - *376
responses:
'204':
description: Response
@@ -54539,9 +54091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#enable-a-workflow
parameters:
- - *327
- - *328
- - *379
+ - *324
+ - *325
+ - *376
responses:
'204':
description: Response
@@ -54568,19 +54120,19 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *327
- - *328
+ - *324
+ - *325
+ - *376
+ - *377
+ - *378
- *379
- *380
+ - *17
+ - *19
- *381
+ - *360
- *382
- *383
- - *17
- - *19
- - *384
- - *363
- - *385
- - *386
responses:
'200':
description: Response
@@ -54596,9 +54148,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *364
+ items: *361
examples:
- default: *387
+ default: *384
headers:
Link: *59
x-github:
@@ -54630,9 +54182,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/workflows#get-workflow-usage
parameters:
- - *327
- - *328
- - *379
+ - *324
+ - *325
+ - *376
responses:
'200':
description: Response
@@ -54693,8 +54245,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-activities
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *53
- *17
- *45
@@ -54858,8 +54410,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#list-assignees
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -54896,8 +54448,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: assignee
in: path
required: true
@@ -54933,8 +54485,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#create-an-attestation
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -55046,8 +54598,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/attestations#list-attestations
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *45
- *46
@@ -55104,7 +54656,7 @@ paths:
initiator:
type: string
examples:
- default: *388
+ default: *385
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -55124,8 +54676,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -55133,7 +54685,7 @@ paths:
application/json:
schema:
type: array
- items: &389
+ items: &386
title: Autolink reference
description: An autolink reference.
type: object
@@ -55187,8 +54739,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -55227,9 +54779,9 @@ paths:
description: response
content:
application/json:
- schema: *389
+ schema: *386
examples:
- default: &390
+ default: &387
value:
id: 1
key_prefix: TICKET-
@@ -55260,9 +54812,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *327
- - *328
- - &391
+ - *324
+ - *325
+ - &388
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -55274,9 +54826,9 @@ paths:
description: Response
content:
application/json:
- schema: *389
+ schema: *386
examples:
- default: *390
+ default: *387
'404': *6
x-github:
githubCloudOnly: false
@@ -55296,9 +54848,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *327
- - *328
- - *391
+ - *324
+ - *325
+ - *388
responses:
'204':
description: Response
@@ -55322,8 +54874,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response if Dependabot is enabled
@@ -55371,8 +54923,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -55393,8 +54945,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -55414,8 +54966,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#list-branches
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -55453,7 +55005,7 @@ paths:
- url
protected:
type: boolean
- protection: &393
+ protection: &390
title: Branch Protection
description: Branch Protection
type: object
@@ -55495,7 +55047,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &396
+ enforce_admins: &393
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -55510,7 +55062,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &398
+ required_pull_request_reviews: &395
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -55586,7 +55138,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &395
+ restrictions: &392
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -55863,9 +55415,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#get-a-branch
parameters:
- - *327
- - *328
- - &394
+ - *324
+ - *325
+ - &391
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).
@@ -55879,14 +55431,14 @@ paths:
description: Response
content:
application/json:
- schema: &404
+ schema: &401
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &461
+ commit: &458
title: Commit
description: Commit
type: object
@@ -55920,7 +55472,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &392
+ properties: &389
name:
type: string
example: '"Chris Wanstrath"'
@@ -55936,7 +55488,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *392
+ properties: *389
nullable: true
message:
type: string
@@ -55957,7 +55509,7 @@ paths:
required:
- sha
- url
- verification: &513
+ verification: &510
title: Verification
type: object
properties:
@@ -56027,7 +55579,7 @@ paths:
type: integer
files:
type: array
- items: &474
+ items: &471
title: Diff Entry
description: Diff Entry
type: object
@@ -56111,7 +55663,7 @@ paths:
- self
protected:
type: boolean
- protection: *393
+ protection: *390
protection_url:
type: string
format: uri
@@ -56218,7 +55770,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *331
+ '301': *328
'404': *6
x-github:
githubCloudOnly: false
@@ -56240,15 +55792,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *393
+ schema: *390
examples:
default:
value:
@@ -56442,9 +55994,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -56699,7 +56251,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &401
+ required_status_checks: &398
title: Status Check Policy
description: Status Check Policy
type: object
@@ -56851,7 +56403,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *395
+ restrictions: *392
required_conversation_resolution:
type: object
properties:
@@ -56963,9 +56515,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -56990,17 +56542,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: &397
+ default: &394
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -57022,17 +56574,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: *397
+ default: *394
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -57051,9 +56603,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57078,17 +56630,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *398
+ schema: *395
examples:
- default: &399
+ default: &396
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -57184,9 +56736,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -57284,9 +56836,9 @@ paths:
description: Response
content:
application/json:
- schema: *398
+ schema: *395
examples:
- default: *399
+ default: *396
'422': *15
x-github:
githubCloudOnly: false
@@ -57307,9 +56859,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57336,17 +56888,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: &400
+ default: &397
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -57369,17 +56921,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *396
+ schema: *393
examples:
- default: *400
+ default: *397
'404': *6
x-github:
githubCloudOnly: false
@@ -57399,9 +56951,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57426,17 +56978,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: &402
+ default: &399
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -57462,9 +57014,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -57516,9 +57068,9 @@ paths:
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'404': *6
'422': *15
x-github:
@@ -57540,9 +57092,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57566,9 +57118,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
@@ -57602,9 +57154,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -57671,9 +57223,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -57737,9 +57289,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
content:
application/json:
@@ -57805,15 +57357,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
content:
application/json:
- schema: *395
+ schema: *392
examples:
default:
value:
@@ -57904,9 +57456,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'204':
description: Response
@@ -57929,9 +57481,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
@@ -57941,7 +57493,7 @@ paths:
type: array
items: *5
examples:
- default: &403
+ default: &400
value:
- id: 1
slug: octoapp
@@ -57998,9 +57550,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58034,7 +57586,7 @@ paths:
type: array
items: *5
examples:
- default: *403
+ default: *400
'422': *15
x-github:
githubCloudOnly: false
@@ -58055,9 +57607,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58091,7 +57643,7 @@ paths:
type: array
items: *5
examples:
- default: *403
+ default: *400
'422': *15
x-github:
githubCloudOnly: false
@@ -58112,9 +57664,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58148,7 +57700,7 @@ paths:
type: array
items: *5
examples:
- default: *403
+ default: *400
'422': *15
x-github:
githubCloudOnly: false
@@ -58170,9 +57722,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
@@ -58202,9 +57754,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -58263,9 +57815,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: false
content:
@@ -58324,9 +57876,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
content:
application/json:
@@ -58385,9 +57937,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
responses:
'200':
description: Response
@@ -58421,9 +57973,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58481,9 +58033,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58541,9 +58093,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58603,9 +58155,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#rename-a-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
requestBody:
required: true
content:
@@ -58627,7 +58179,7 @@ paths:
description: Response
content:
application/json:
- schema: *404
+ schema: *401
examples:
default:
value:
@@ -58743,8 +58295,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#create-a-check-run
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -59023,7 +58575,7 @@ paths:
description: Response
content:
application/json:
- schema: &405
+ schema: &402
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -59143,7 +58695,7 @@ paths:
check.
type: array
items: *80
- deployment: &725
+ deployment: &720
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -59423,9 +58975,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#get-a-check-run
parameters:
- - *327
- - *328
- - &406
+ - *324
+ - *325
+ - &403
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -59437,9 +58989,9 @@ paths:
description: Response
content:
application/json:
- schema: *405
+ schema: *402
examples:
- default: &407
+ default: &404
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -59539,9 +59091,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#update-a-check-run
parameters:
- - *327
- - *328
- - *406
+ - *324
+ - *325
+ - *403
requestBody:
required: true
content:
@@ -59781,9 +59333,9 @@ paths:
description: Response
content:
application/json:
- schema: *405
+ schema: *402
examples:
- default: *407
+ default: *404
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -59803,9 +59355,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-run-annotations
parameters:
- - *327
- - *328
- - *406
+ - *324
+ - *325
+ - *403
- *17
- *19
responses:
@@ -59900,9 +59452,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run
parameters:
- - *327
- - *328
- - *406
+ - *324
+ - *325
+ - *403
responses:
'201':
description: Response
@@ -59946,8 +59498,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#create-a-check-suite
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -59969,7 +59521,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &410
+ schema: &407
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -60055,12 +59607,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &751
+ head_commit: &746
title: Simple Commit
description: A commit.
type: object
- properties: *408
- required: *409
+ properties: *405
+ required: *406
latest_check_runs_count:
type: integer
check_runs_url:
@@ -60088,7 +59640,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &411
+ default: &408
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -60379,9 +59931,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *410
+ schema: *407
examples:
- default: *411
+ default: *408
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60400,8 +59952,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -60710,9 +60262,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#get-a-check-suite
parameters:
- - *327
- - *328
- - &412
+ - *324
+ - *325
+ - &409
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -60724,9 +60276,9 @@ paths:
description: Response
content:
application/json:
- schema: *410
+ schema: *407
examples:
- default: *411
+ default: *408
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -60749,17 +60301,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *327
- - *328
- - *412
- - &467
+ - *324
+ - *325
+ - *409
+ - &464
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &468
+ - &465
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -60798,9 +60350,9 @@ paths:
type: integer
check_runs:
type: array
- items: *405
+ items: *402
examples:
- default: &469
+ default: &466
value:
total_count: 1
check_runs:
@@ -60902,9 +60454,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *327
- - *328
- - *412
+ - *324
+ - *325
+ - *409
responses:
'201':
description: Response
@@ -60937,21 +60489,21 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *327
- - *328
- - *413
- - *414
+ - *324
+ - *325
+ - *410
+ - *411
- *19
- *17
- - &431
+ - &428
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: *415
- - &432
+ schema: *412
+ - &429
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -60976,13 +60528,13 @@ paths:
be returned.
in: query
required: false
- schema: *416
+ schema: *413
- name: severity
description: If specified, only code scanning alerts with this severity will
be returned.
in: query
required: false
- schema: *417
+ schema: *414
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -61006,7 +60558,7 @@ paths:
updated_at: *172
url: *173
html_url: *174
- instances_url: *418
+ instances_url: *415
state: *179
fixed_at: *175
dismissed_by:
@@ -61017,11 +60569,11 @@ paths:
required: *21
nullable: true
dismissed_at: *176
- dismissed_reason: *419
- dismissed_comment: *420
- rule: *421
- tool: *422
- most_recent_instance: *423
+ dismissed_reason: *416
+ dismissed_comment: *417
+ rule: *418
+ tool: *419
+ most_recent_instance: *420
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -61147,7 +60699,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &424
+ '403': &421
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -61174,9 +60726,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *327
- - *328
- - &425
+ - *324
+ - *325
+ - &422
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -61190,7 +60742,7 @@ paths:
description: Response
content:
application/json:
- schema: &426
+ schema: &423
type: object
properties:
number: *170
@@ -61198,7 +60750,7 @@ paths:
updated_at: *172
url: *173
html_url: *174
- instances_url: *418
+ instances_url: *415
state: *179
fixed_at: *175
dismissed_by:
@@ -61209,8 +60761,8 @@ paths:
required: *21
nullable: true
dismissed_at: *176
- dismissed_reason: *419
- dismissed_comment: *420
+ dismissed_reason: *416
+ dismissed_comment: *417
rule:
type: object
properties:
@@ -61264,8 +60816,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *422
- most_recent_instance: *423
+ tool: *419
+ most_recent_instance: *420
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -61364,7 +60916,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -61384,9 +60936,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
requestBody:
required: true
content:
@@ -61401,8 +60953,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *419
- dismissed_comment: *420
+ dismissed_reason: *416
+ dismissed_comment: *417
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -61430,7 +60982,7 @@ paths:
description: Response
content:
application/json:
- schema: *426
+ schema: *423
examples:
default:
value:
@@ -61506,7 +61058,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &430
+ '403': &427
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -61533,15 +61085,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:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
responses:
'200':
description: Response
content:
application/json:
- schema: &427
+ schema: &424
type: object
properties:
status:
@@ -61567,13 +61119,13 @@ paths:
- description
- started_at
examples:
- default: &428
+ default: &425
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &429
+ '400': &426
description: Bad Request
content:
application/json:
@@ -61584,7 +61136,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': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -61609,29 +61161,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:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
responses:
'200':
description: OK
content:
application/json:
- schema: *427
+ schema: *424
examples:
- default: *428
+ default: *425
'202':
description: Accepted
content:
application/json:
- schema: *427
+ schema: *424
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *429
+ '400': *426
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -61663,9 +61215,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:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
requestBody:
required: false
content:
@@ -61710,8 +61262,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *429
- '403': *430
+ '400': *426
+ '403': *427
'404': *6
'422':
description: Unprocessable Entity
@@ -61735,13 +61287,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
- *19
- *17
- - *431
- - *432
+ - *428
+ - *429
responses:
'200':
description: Response
@@ -61752,10 +61304,10 @@ paths:
items:
type: object
properties:
- ref: *415
- analysis_key: *433
- environment: *434
- category: *435
+ ref: *412
+ analysis_key: *430
+ environment: *431
+ category: *432
state:
type: string
description: State of a code scanning alert instance.
@@ -61770,7 +61322,7 @@ paths:
properties:
text:
type: string
- location: *436
+ location: *433
html_url:
type: string
classifications:
@@ -61778,7 +61330,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: *437
+ items: *434
examples:
default:
value:
@@ -61817,7 +61369,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -61851,25 +61403,25 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *327
- - *328
- - *413
- - *414
+ - *324
+ - *325
+ - *410
+ - *411
- *19
- *17
- - *432
+ - *429
- 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: *415
+ schema: *412
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &438
+ schema: &435
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -61890,23 +61442,23 @@ paths:
application/json:
schema:
type: array
- items: &439
+ items: &436
type: object
properties:
- ref: *415
- commit_sha: &447
+ ref: *412
+ commit_sha: &444
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: *433
+ analysis_key: *430
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *435
+ category: *432
error:
type: string
example: error reading field xyz
@@ -61930,8 +61482,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *438
- tool: *422
+ sarif_id: *435
+ tool: *419
deletable:
type: boolean
warning:
@@ -61992,7 +61544,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -62028,8 +61580,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:
- - *327
- - *328
+ - *324
+ - *325
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -62042,7 +61594,7 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
response:
summary: application/json response
@@ -62096,7 +61648,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *424
+ '403': *421
'404': *6
'422':
description: Response if analysis could not be processed
@@ -62183,8 +61735,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:
- - *327
- - *328
+ - *324
+ - *325
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -62237,7 +61789,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': *430
+ '403': *427
'404': *6
'503': *113
x-github:
@@ -62259,8 +61811,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -62268,7 +61820,7 @@ paths:
application/json:
schema:
type: array
- items: &440
+ items: &437
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -62379,7 +61931,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': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -62408,8 +61960,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: language
in: path
description: The language of the CodeQL database.
@@ -62421,7 +61973,7 @@ paths:
description: Response
content:
application/json:
- schema: *440
+ schema: *437
examples:
default:
value:
@@ -62453,9 +62005,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': &476
+ '302': &473
description: Found
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -62477,8 +62029,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: language
in: path
description: The language of the CodeQL database.
@@ -62488,7 +62040,7 @@ paths:
responses:
'204':
description: Response
- '403': *430
+ '403': *427
'404': *6
'503': *113
x-github:
@@ -62516,8 +62068,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -62526,7 +62078,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &441
+ language: &438
type: string
description: The language targeted by the CodeQL query
enum:
@@ -62606,7 +62158,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &445
+ schema: &442
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -62616,7 +62168,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *58
actor: *4
- query_language: *441
+ query_language: *438
query_pack_url:
type: string
description: The download url for the query pack.
@@ -62663,7 +62215,7 @@ paths:
items:
type: object
properties:
- repository: &442
+ repository: &439
title: Repository Identifier
description: Repository Identifier
type: object
@@ -62699,7 +62251,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &446
+ analysis_status: &443
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -62731,7 +62283,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &443
+ access_mismatch_repos: &440
type: object
properties:
repository_count:
@@ -62745,7 +62297,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: *442
+ items: *439
required:
- repository_count
- repositories
@@ -62767,8 +62319,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *443
- over_limit_repos: *443
+ no_codeql_db_repos: *440
+ over_limit_repos: *440
required:
- access_mismatch_repos
- not_found_repos
@@ -62784,7 +62336,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &444
+ value: &441
summary: Default response
value:
id: 1
@@ -62930,10 +62482,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *444
+ value: *441
repository_lists:
summary: Response for a successful variant analysis submission
- value: *444
+ value: *441
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -62961,8 +62513,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:
- - *327
- - *328
+ - *324
+ - *325
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -62974,9 +62526,9 @@ paths:
description: Response
content:
application/json:
- schema: *445
+ schema: *442
examples:
- default: *444
+ default: *441
'404': *6
'503': *113
x-github:
@@ -62999,7 +62551,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:
- - *327
+ - *324
- name: repo
in: path
description: The name of the controller repository.
@@ -63034,7 +62586,7 @@ paths:
type: object
properties:
repository: *58
- analysis_status: *446
+ analysis_status: *443
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -63159,8 +62711,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -63245,7 +62797,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *424
+ '403': *421
'404': *6
'503': *113
x-github:
@@ -63266,8 +62818,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -63359,7 +62911,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *430
+ '403': *427
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -63430,8 +62982,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -63439,7 +62991,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *447
+ commit_sha: *444
ref:
type: string
description: |-
@@ -63497,7 +63049,7 @@ paths:
schema:
type: object
properties:
- id: *438
+ id: *435
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -63511,7 +63063,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': *430
+ '403': *427
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -63534,8 +63086,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -63581,7 +63133,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': *424
+ '403': *421
'404':
description: Not Found if the sarif id does not match any upload
'503': *113
@@ -63606,8 +63158,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -63688,8 +63240,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-codeowners-errors
parameters:
- - *327
- - *328
+ - *324
+ - *325
- 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
@@ -63809,8 +63361,8 @@ paths:
parameters:
- *17
- *19
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -64124,8 +63676,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -64190,7 +63742,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -64198,7 +63750,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'400': *14
'401': *25
'403': *29
@@ -64227,8 +63779,8 @@ paths:
parameters:
- *17
- *19
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -64292,8 +63844,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -64328,14 +63880,14 @@ paths:
type: integer
machines:
type: array
- items: &670
+ items: &665
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *449
- required: *450
+ properties: *446
+ required: *447
examples:
- default: &671
+ default: &666
value:
total_count: 2
machines:
@@ -64375,8 +63927,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -64460,8 +64012,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:
- - *327
- - *328
+ - *324
+ - *325
- 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
@@ -64527,8 +64079,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -64546,7 +64098,7 @@ paths:
type: integer
secrets:
type: array
- items: &454
+ items: &451
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -64566,7 +64118,7 @@ paths:
- created_at
- updated_at
examples:
- default: *451
+ default: *448
headers:
Link: *59
x-github:
@@ -64589,16 +64141,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *452
+ schema: *449
examples:
- default: *453
+ default: *450
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -64618,17 +64170,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'200':
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: *455
+ default: *452
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -64648,8 +64200,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
requestBody:
required: true
@@ -64702,8 +64254,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'204':
@@ -64732,8 +64284,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -64775,7 +64327,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &456
+ properties: &453
login:
type: string
example: octocat
@@ -64868,7 +64420,7 @@ paths:
user_view_type:
type: string
example: public
- required: &457
+ required: &454
- avatar_url
- events_url
- followers_url
@@ -64942,8 +64494,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *64
responses:
'204':
@@ -64990,8 +64542,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *64
requestBody:
required: false
@@ -65018,7 +64570,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &526
+ schema: &523
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -65247,8 +64799,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *64
responses:
'204':
@@ -65280,8 +64832,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *64
responses:
'200':
@@ -65302,8 +64854,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *456
- required: *457
+ properties: *453
+ required: *454
nullable: true
required:
- permission
@@ -65358,8 +64910,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -65369,7 +64921,7 @@ paths:
application/json:
schema:
type: array
- items: &458
+ items: &455
title: Commit Comment
description: Commit Comment
type: object
@@ -65427,7 +64979,7 @@ paths:
- created_at
- updated_at
examples:
- default: &463
+ default: &460
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -65486,17 +65038,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#get-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'200':
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- default: &464
+ default: &461
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -65553,8 +65105,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#update-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -65577,7 +65129,7 @@ paths:
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
default:
value:
@@ -65628,8 +65180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'204':
@@ -65651,8 +65203,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -65679,7 +65231,7 @@ paths:
application/json:
schema:
type: array
- items: &459
+ items: &456
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -65722,7 +65274,7 @@ paths:
- content
- created_at
examples:
- default: &530
+ default: &527
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -65767,8 +65319,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -65801,9 +65353,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: &460
+ default: &457
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -65832,9 +65384,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -65856,10 +65408,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- - &531
+ - &528
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -65914,8 +65466,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-commits
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -65971,9 +65523,9 @@ paths:
application/json:
schema:
type: array
- items: *461
+ items: *458
examples:
- default: &580
+ default: &577
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -66067,9 +65619,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *327
- - *328
- - &462
+ - *324
+ - *325
+ - &459
name: commit_sha
description: The SHA of the commit.
in: path
@@ -66141,9 +65693,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#list-commit-comments
parameters:
- - *327
- - *328
- - *462
+ - *324
+ - *325
+ - *459
- *17
- *19
responses:
@@ -66153,9 +65705,9 @@ paths:
application/json:
schema:
type: array
- items: *458
+ items: *455
examples:
- default: *463
+ default: *460
headers:
Link: *59
x-github:
@@ -66183,9 +65735,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/comments#create-a-commit-comment
parameters:
- - *327
- - *328
- - *462
+ - *324
+ - *325
+ - *459
requestBody:
required: true
content:
@@ -66220,9 +65772,9 @@ paths:
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- default: *464
+ default: *461
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -66250,9 +65802,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *327
- - *328
- - *462
+ - *324
+ - *325
+ - *459
- *17
- *19
responses:
@@ -66262,9 +65814,9 @@ paths:
application/json:
schema:
type: array
- items: *465
+ items: *462
examples:
- default: &572
+ default: &569
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -66801,11 +66353,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#get-a-commit
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *19
- *17
- - &466
+ - &463
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)"
@@ -66820,9 +66372,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: &557
+ default: &554
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -66935,11 +66487,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *327
- - *328
- - *466
- - *467
- - *468
+ - *324
+ - *325
+ - *463
+ - *464
+ - *465
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -66973,9 +66525,9 @@ paths:
type: integer
check_runs:
type: array
- items: *405
+ items: *402
examples:
- default: *469
+ default: *466
headers:
Link: *59
x-github:
@@ -67000,9 +66552,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *327
- - *328
- - *466
+ - *324
+ - *325
+ - *463
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -67010,7 +66562,7 @@ paths:
schema:
type: integer
example: 1
- - *467
+ - *464
- *17
- *19
responses:
@@ -67028,7 +66580,7 @@ paths:
type: integer
check_suites:
type: array
- items: *410
+ items: *407
examples:
default:
value:
@@ -67228,9 +66780,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *327
- - *328
- - *466
+ - *324
+ - *325
+ - *463
- *17
- *19
responses:
@@ -67428,9 +66980,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *327
- - *328
- - *466
+ - *324
+ - *325
+ - *463
- *17
- *19
responses:
@@ -67440,7 +66992,7 @@ paths:
application/json:
schema:
type: array
- items: &645
+ items: &642
title: Status
description: The status of a commit.
type: object
@@ -67521,7 +67073,7 @@ paths:
site_admin: false
headers:
Link: *59
- '301': *331
+ '301': *328
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67549,8 +67101,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -67579,20 +67131,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *470
- required: *471
+ properties: *467
+ required: *468
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &472
+ properties: &469
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &473
+ required: &470
- url
- html_url
nullable: true
@@ -67606,26 +67158,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *472
- required: *473
+ properties: *469
+ required: *470
nullable: true
readme:
title: Community Health File
type: object
- properties: *472
- required: *473
+ properties: *469
+ required: *470
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *472
- required: *473
+ properties: *469
+ required: *470
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *472
- required: *473
+ properties: *469
+ required: *470
nullable: true
required:
- code_of_conduct
@@ -67752,8 +67304,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/commits#compare-two-commits
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *19
- *17
- name: basehead
@@ -67796,8 +67348,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *461
- merge_base_commit: *461
+ base_commit: *458
+ merge_base_commit: *458
status:
type: string
enum:
@@ -67817,10 +67369,10 @@ paths:
example: 6
commits:
type: array
- items: *461
+ items: *458
files:
type: array
- items: *474
+ items: *471
required:
- url
- html_url
@@ -68106,8 +67658,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-repository-content
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: path
description: path parameter
in: path
@@ -68250,7 +67802,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &475
+ response-if-content-is-a-file: &472
summary: Response if content is a file
value:
type: file
@@ -68382,7 +67934,7 @@ paths:
- size
- type
- url
- - &585
+ - &582
title: Content File
description: Content File
type: object
@@ -68583,7 +68135,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *475
+ response-if-content-is-a-file: *472
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -68652,7 +68204,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *476
+ '302': *473
'304': *37
x-github:
githubCloudOnly: false
@@ -68675,8 +68227,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: path
description: path parameter
in: path
@@ -68769,7 +68321,7 @@ paths:
description: Response
content:
application/json:
- schema: &477
+ schema: &474
title: File Commit
description: File Commit
type: object
@@ -68921,7 +68473,7 @@ paths:
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
example-for-creating-a-file:
value:
@@ -68975,7 +68527,7 @@ paths:
schema:
oneOf:
- *3
- - &508
+ - &505
description: Repository rule violation was detected
type: object
properties:
@@ -68996,7 +68548,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &637
+ placeholder_id: &634
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -69028,8 +68580,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#delete-a-file
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: path
description: path parameter
in: path
@@ -69090,7 +68642,7 @@ paths:
description: Response
content:
application/json:
- schema: *477
+ schema: *474
examples:
default:
value:
@@ -69145,8 +68697,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-contributors
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -69269,8 +68821,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *190
- *191
- *192
@@ -69282,7 +68834,7 @@ paths:
schema:
type: string
- *194
- - *478
+ - *475
- *195
- *196
- *53
@@ -69303,7 +68855,7 @@ paths:
application/json:
schema:
type: array
- items: &482
+ items: &479
type: object
description: A Dependabot alert.
properties:
@@ -69349,7 +68901,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *479
+ security_advisory: *476
security_vulnerability: *57
url: *173
html_url: *174
@@ -69380,8 +68932,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *175
- auto_dismissed_at: *480
- dismissal_request: *481
+ auto_dismissed_at: *477
+ dismissal_request: *478
required:
- number
- state
@@ -69611,9 +69163,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *327
- - *328
- - &483
+ - *324
+ - *325
+ - &480
name: alert_number
in: path
description: |-
@@ -69628,7 +69180,7 @@ paths:
description: Response
content:
application/json:
- schema: *482
+ schema: *479
examples:
default:
value:
@@ -69741,9 +69293,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *327
- - *328
- - *483
+ - *324
+ - *325
+ - *480
requestBody:
required: true
content:
@@ -69788,7 +69340,7 @@ paths:
description: Response
content:
application/json:
- schema: *482
+ schema: *479
examples:
default:
value:
@@ -69917,8 +69469,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -69936,7 +69488,7 @@ paths:
type: integer
secrets:
type: array
- items: &486
+ items: &483
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -69989,16 +69541,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *484
+ schema: *481
examples:
- default: *485
+ default: *482
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -70018,15 +69570,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'200':
description: Response
content:
application/json:
- schema: *486
+ schema: *483
examples:
default:
value:
@@ -70052,8 +69604,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
requestBody:
required: true
@@ -70106,8 +69658,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *160
responses:
'204':
@@ -70130,8 +69682,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:
- - *327
- - *328
+ - *324
+ - *325
- 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
@@ -70291,8 +69843,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -70531,8 +70083,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -70607,7 +70159,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &487
+ metadata: &484
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -70640,7 +70192,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *487
+ metadata: *484
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -70653,7 +70205,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *487
+ metadata: *484
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -70782,8 +70334,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#list-deployments
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -70823,9 +70375,9 @@ paths:
application/json:
schema:
type: array
- items: *488
+ items: *485
examples:
- default: *489
+ default: *486
headers:
Link: *59
x-github:
@@ -70891,8 +70443,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#create-a-deployment
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -70973,7 +70525,7 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
simple-example:
summary: Simple example
@@ -71046,9 +70598,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#get-a-deployment
parameters:
- - *327
- - *328
- - &490
+ - *324
+ - *325
+ - &487
name: deployment_id
description: deployment_id parameter
in: path
@@ -71060,7 +70612,7 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
default:
value:
@@ -71125,9 +70677,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment
parameters:
- - *327
- - *328
- - *490
+ - *324
+ - *325
+ - *487
responses:
'204':
description: Response
@@ -71149,9 +70701,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *327
- - *328
- - *490
+ - *324
+ - *325
+ - *487
- *17
- *19
responses:
@@ -71161,7 +70713,7 @@ paths:
application/json:
schema:
type: array
- items: &491
+ items: &488
title: Deployment Status
description: The status of a deployment.
type: object
@@ -71322,9 +70874,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *327
- - *328
- - *490
+ - *324
+ - *325
+ - *487
requestBody:
required: true
content:
@@ -71399,9 +70951,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: &492
+ default: &489
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -71457,9 +71009,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *327
- - *328
- - *490
+ - *324
+ - *325
+ - *487
- name: status_id
in: path
required: true
@@ -71470,9 +71022,9 @@ paths:
description: Response
content:
application/json:
- schema: *491
+ schema: *488
examples:
- default: *492
+ default: *489
'404': *6
x-github:
githubCloudOnly: false
@@ -71497,8 +71049,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -71555,8 +71107,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#list-environments
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -71573,7 +71125,7 @@ paths:
type: integer
environments:
type: array
- items: &494
+ items: &491
title: Environment
description: Details of a deployment environment
type: object
@@ -71625,7 +71177,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &496
+ wait_timer: &493
type: integer
example: 30
description: The amount of time to delay a job after
@@ -71662,7 +71214,7 @@ paths:
items:
type: object
properties:
- type: *493
+ type: *490
reviewer:
anyOf:
- *4
@@ -71686,7 +71238,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &497
+ deployment_branch_policy: &494
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -71802,9 +71354,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#get-an-environment
parameters:
- - *327
- - *328
- - &495
+ - *324
+ - *325
+ - &492
name: environment_name
in: path
required: true
@@ -71817,9 +71369,9 @@ paths:
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: &498
+ default: &495
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -71903,9 +71455,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
requestBody:
required: false
content:
@@ -71914,7 +71466,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *496
+ wait_timer: *493
prevent_self_review:
type: boolean
example: false
@@ -71931,13 +71483,13 @@ paths:
items:
type: object
properties:
- type: *493
+ type: *490
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *497
+ deployment_branch_policy: *494
additionalProperties: false
examples:
default:
@@ -71957,9 +71509,9 @@ paths:
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: *498
+ default: *495
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -71983,9 +71535,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/environments#delete-an-environment
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
responses:
'204':
description: Default response
@@ -72010,9 +71562,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *17
- *19
responses:
@@ -72030,7 +71582,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &499
+ items: &496
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -72087,9 +71639,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
requestBody:
required: true
content:
@@ -72135,9 +71687,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- example-wildcard: &500
+ example-wildcard: &497
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -72179,10 +71731,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *327
- - *328
- - *495
- - &501
+ - *324
+ - *325
+ - *492
+ - &498
name: branch_policy_id
in: path
required: true
@@ -72194,9 +71746,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72215,10 +71767,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *327
- - *328
- - *495
- - *501
+ - *324
+ - *325
+ - *492
+ - *498
requestBody:
required: true
content:
@@ -72246,9 +71798,9 @@ paths:
description: Response
content:
application/json:
- schema: *499
+ schema: *496
examples:
- default: *500
+ default: *497
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72267,10 +71819,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *327
- - *328
- - *495
- - *501
+ - *324
+ - *325
+ - *492
+ - *498
responses:
'204':
description: Response
@@ -72295,9 +71847,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *495
- - *328
- - *327
+ - *492
+ - *325
+ - *324
responses:
'200':
description: List of deployment protection rules
@@ -72313,7 +71865,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &502
+ items: &499
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -72332,7 +71884,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &503
+ app: &500
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -72431,9 +71983,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:
- - *495
- - *328
- - *327
+ - *492
+ - *325
+ - *324
requestBody:
content:
application/json:
@@ -72454,9 +72006,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *502
+ schema: *499
examples:
- default: &504
+ default: &501
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -72491,9 +72043,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:
- - *495
- - *328
- - *327
+ - *492
+ - *325
+ - *324
- *19
- *17
responses:
@@ -72512,7 +72064,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *503
+ items: *500
examples:
default:
value:
@@ -72547,10 +72099,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *327
- - *328
- - *495
- - &505
+ - *324
+ - *325
+ - *492
+ - &502
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -72562,9 +72114,9 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
- default: *504
+ default: *501
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72585,10 +72137,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *495
- - *328
- - *327
- - *505
+ - *492
+ - *325
+ - *324
+ - *502
responses:
'204':
description: Response
@@ -72614,9 +72166,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#list-environment-secrets
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *17
- *19
responses:
@@ -72634,9 +72186,9 @@ paths:
type: integer
secrets:
type: array
- items: *372
+ items: *369
examples:
- default: *373
+ default: *370
headers:
Link: *59
x-github:
@@ -72661,17 +72213,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
responses:
'200':
description: Response
content:
application/json:
- schema: *374
+ schema: *371
examples:
- default: *375
+ default: *372
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72693,18 +72245,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *160
responses:
'200':
description: Response
content:
application/json:
- schema: *372
+ schema: *369
examples:
- default: *506
+ default: *503
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72726,9 +72278,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *160
requestBody:
required: true
@@ -72786,9 +72338,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *160
responses:
'204':
@@ -72814,10 +72366,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#list-environment-variables
parameters:
- - *327
- - *328
- - *495
- - *343
+ - *324
+ - *325
+ - *492
+ - *340
- *19
responses:
'200':
@@ -72834,9 +72386,9 @@ paths:
type: integer
variables:
type: array
- items: *376
+ items: *373
examples:
- default: *377
+ default: *374
headers:
Link: *59
x-github:
@@ -72859,9 +72411,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#create-an-environment-variable
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
requestBody:
required: true
content:
@@ -72913,18 +72465,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#get-an-environment-variable
parameters:
- - *327
- - *328
- - *495
+ - *324
+ - *325
+ - *492
- *163
responses:
'200':
description: Response
content:
application/json:
- schema: *376
+ schema: *373
examples:
- default: *507
+ default: *504
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72945,10 +72497,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#update-an-environment-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
- - *495
+ - *492
requestBody:
required: true
content:
@@ -72990,10 +72542,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *163
- - *495
+ - *492
responses:
'204':
description: Response
@@ -73015,8 +72567,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/events#list-repository-events
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -73084,8 +72636,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#list-forks
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -73244,8 +72796,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/forks#create-a-fork
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -73277,9 +72829,9 @@ paths:
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
+ default: *329
'400': *14
'422': *15
'403': *29
@@ -73300,8 +72852,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#create-a-blob
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -73361,7 +72913,7 @@ paths:
schema:
oneOf:
- *121
- - *508
+ - *505
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73386,8 +72938,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/blobs#get-a-blob
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: file_sha
in: path
required: true
@@ -73486,8 +73038,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#create-a-commit
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -73596,7 +73148,7 @@ paths:
description: Response
content:
application/json:
- schema: &509
+ schema: &506
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -73810,15 +73362,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/commits#get-a-commit-object
parameters:
- - *327
- - *328
- - *462
+ - *324
+ - *325
+ - *459
responses:
'200':
description: Response
content:
application/json:
- schema: *509
+ schema: *506
examples:
default:
value:
@@ -73874,9 +73426,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#list-matching-references
parameters:
- - *327
- - *328
- - &510
+ - *324
+ - *325
+ - &507
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.
@@ -73893,7 +73445,7 @@ paths:
application/json:
schema:
type: array
- items: &511
+ items: &508
title: Git Reference
description: Git references within a repository
type: object
@@ -73968,17 +73520,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#get-a-reference
parameters:
- - *327
- - *328
- - *510
+ - *324
+ - *325
+ - *507
responses:
'200':
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: &512
+ default: &509
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -74007,8 +73559,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#create-a-reference
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -74037,9 +73589,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: *512
+ default: *509
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -74065,9 +73617,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#update-a-reference
parameters:
- - *327
- - *328
- - *510
+ - *324
+ - *325
+ - *507
requestBody:
required: true
content:
@@ -74096,9 +73648,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: *512
+ default: *509
'422': *15
'409': *52
x-github:
@@ -74116,9 +73668,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/refs#delete-a-reference
parameters:
- - *327
- - *328
- - *510
+ - *324
+ - *325
+ - *507
responses:
'204':
description: Response
@@ -74173,8 +73725,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#create-a-tag-object
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -74241,7 +73793,7 @@ paths:
description: Response
content:
application/json:
- schema: &514
+ schema: &511
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -74292,7 +73844,7 @@ paths:
- sha
- type
- url
- verification: *513
+ verification: *510
required:
- sha
- url
@@ -74302,7 +73854,7 @@ paths:
- tag
- message
examples:
- default: &515
+ default: &512
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -74375,8 +73927,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/tags#get-a-tag
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: tag_sha
in: path
required: true
@@ -74387,9 +73939,9 @@ paths:
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *515
+ default: *512
'404': *6
'409': *52
x-github:
@@ -74413,8 +73965,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#create-a-tree
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -74487,7 +74039,7 @@ paths:
description: Response
content:
application/json:
- schema: &516
+ schema: &513
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -74583,8 +74135,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/git/trees#get-a-tree
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -74607,7 +74159,7 @@ paths:
description: Response
content:
application/json:
- schema: *516
+ schema: *513
examples:
default-response:
summary: Default response
@@ -74666,8 +74218,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -74677,7 +74229,7 @@ paths:
application/json:
schema:
type: array
- items: &517
+ items: &514
title: Webhook
description: Webhooks for repositories.
type: object
@@ -74731,7 +74283,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &759
+ last_response: &754
title: Hook Response
type: object
properties:
@@ -74805,8 +74357,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -74858,9 +74410,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: &518
+ default: &515
value:
type: Repository
id: 12345678
@@ -74908,17 +74460,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
'404': *6
x-github:
githubCloudOnly: false
@@ -74938,8 +74490,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
requestBody:
required: true
@@ -74985,9 +74537,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *518
+ default: *515
'422': *15
'404': *6
x-github:
@@ -75008,8 +74560,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'204':
@@ -75034,8 +74586,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'200':
@@ -75063,8 +74615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
requestBody:
required: false
@@ -75109,8 +74661,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
- *17
- *205
@@ -75142,8 +74694,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
- *16
responses:
@@ -75172,8 +74724,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
- *16
responses:
@@ -75197,8 +74749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'204':
@@ -75224,8 +74776,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *204
responses:
'204':
@@ -75249,8 +74801,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response if immutable releases are enabled
@@ -75296,8 +74848,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-immutable-releases
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204': *183
'409': *52
@@ -75317,8 +74869,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-immutable-releases
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204': *183
'409': *52
@@ -75375,14 +74927,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &519
+ schema: &516
title: Import
description: A repository import from an external source.
type: object
@@ -75481,7 +75033,7 @@ paths:
- html_url
- authors_url
examples:
- default: &522
+ default: &519
value:
vcs: subversion
use_lfs: true
@@ -75497,7 +75049,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': &520
+ '503': &517
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -75526,8 +75078,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#start-an-import
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -75575,7 +75127,7 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
default:
value:
@@ -75600,7 +75152,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75628,8 +75180,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-an-import
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -75678,7 +75230,7 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
example-1:
summary: Example 1
@@ -75726,7 +75278,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': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75749,12 +75301,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75780,9 +75332,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors
parameters:
- - *327
- - *328
- - &692
+ - *324
+ - *325
+ - &687
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -75796,7 +75348,7 @@ paths:
application/json:
schema:
type: array
- items: &521
+ items: &518
title: Porter Author
description: Porter Author
type: object
@@ -75850,7 +75402,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': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75875,8 +75427,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: author_id
in: path
required: true
@@ -75906,7 +75458,7 @@ paths:
description: Response
content:
application/json:
- schema: *521
+ schema: *518
examples:
default:
value:
@@ -75919,7 +75471,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75943,8 +75495,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#get-large-files
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -75985,7 +75537,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76013,8 +75565,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -76041,11 +75593,11 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: *522
+ default: *519
'422': *15
- '503': *520
+ '503': *517
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76068,8 +75620,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -76077,8 +75629,8 @@ paths:
application/json:
schema: *22
examples:
- default: *523
- '301': *331
+ default: *520
+ '301': *328
'404': *6
x-github:
githubCloudOnly: false
@@ -76098,8 +75650,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -76112,7 +75664,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &525
+ default: &522
value:
limit: collaborators_only
origin: repository
@@ -76137,13 +75689,13 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
application/json:
- schema: *524
+ schema: *521
examples:
default:
summary: Example request body
@@ -76157,7 +75709,7 @@ paths:
application/json:
schema: *222
examples:
- default: *525
+ default: *522
'409':
description: Response
x-github:
@@ -76179,8 +75731,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -76203,8 +75755,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -76214,9 +75766,9 @@ paths:
application/json:
schema:
type: array
- items: *526
+ items: *523
examples:
- default: &685
+ default: &680
value:
- id: 1
repository:
@@ -76347,8 +75899,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *226
requestBody:
required: false
@@ -76378,7 +75930,7 @@ paths:
description: Response
content:
application/json:
- schema: *526
+ schema: *523
examples:
default:
value:
@@ -76509,8 +76061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *226
responses:
'204':
@@ -76542,8 +76094,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#list-repository-issues
parameters:
- - *327
- - *328
+ - *324
+ - *325
- 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
@@ -76616,7 +76168,7 @@ paths:
type: array
items: *75
examples:
- default: &538
+ default: &535
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -76764,7 +76316,7 @@ paths:
state_reason: completed
headers:
Link: *59
- '301': *331
+ '301': *328
'422': *15
'404': *6
x-github:
@@ -76793,8 +76345,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#create-an-issue
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -76878,7 +76430,7 @@ paths:
application/json:
schema: *75
examples:
- default: &535
+ default: &532
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -77034,7 +76586,7 @@ paths:
'422': *15
'503': *113
'404': *6
- '410': *527
+ '410': *524
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -77062,8 +76614,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *99
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -77084,9 +76636,9 @@ paths:
application/json:
schema:
type: array
- items: *528
+ items: *525
examples:
- default: &537
+ default: &534
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -77144,17 +76696,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#get-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'200':
description: Response
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: &529
+ default: &526
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -77208,8 +76760,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#update-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -77232,9 +76784,9 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: *529
+ default: *526
'422': *15
x-github:
githubCloudOnly: false
@@ -77252,8 +76804,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'204':
@@ -77274,8 +76826,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -77302,9 +76854,9 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *530
+ default: *527
headers:
Link: *59
'404': *6
@@ -77325,8 +76877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -77359,16 +76911,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'201':
description: Reaction created
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -77390,10 +76942,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- - *531
+ - *528
responses:
'204':
description: Response
@@ -77413,8 +76965,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -77424,7 +76976,7 @@ paths:
application/json:
schema:
type: array
- items: &534
+ items: &531
title: Issue Event
description: Issue Event
type: object
@@ -77467,8 +77019,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *532
- required: *533
+ properties: *529
+ required: *530
nullable: true
label:
title: Issue Event Label
@@ -77775,8 +77327,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#get-an-issue-event
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: event_id
in: path
required: true
@@ -77787,7 +77339,7 @@ paths:
description: Response
content:
application/json:
- schema: *534
+ schema: *531
examples:
default:
value:
@@ -77979,7 +77531,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *527
+ '410': *524
'403': *29
x-github:
githubCloudOnly: false
@@ -78013,9 +77565,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#get-an-issue
parameters:
- - *327
- - *328
- - &536
+ - *324
+ - *325
+ - &533
name: issue_number
description: The number that identifies the issue.
in: path
@@ -78029,10 +77581,10 @@ paths:
application/json:
schema: *75
examples:
- default: *535
- '301': *331
+ default: *532
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
'304': *37
x-github:
githubCloudOnly: false
@@ -78057,9 +77609,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#update-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -78165,13 +77717,13 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
'422': *15
'503': *113
'403': *29
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78189,9 +77741,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -78219,7 +77771,7 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78235,9 +77787,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
content:
application/json:
@@ -78264,7 +77816,7 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78286,9 +77838,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- name: assignee
in: path
required: true
@@ -78328,9 +77880,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#list-issue-comments
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *82
- *17
- *19
@@ -78341,13 +77893,13 @@ paths:
application/json:
schema:
type: array
- items: *528
+ items: *525
examples:
- default: *537
+ default: *534
headers:
Link: *59
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78376,9 +77928,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/comments#create-an-issue-comment
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -78400,16 +77952,16 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: *529
+ default: *526
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *527
+ '410': *524
'422': *15
'404': *6
x-github:
@@ -78437,9 +77989,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -78451,12 +78003,12 @@ paths:
type: array
items: *75
examples:
- default: *538
+ default: *535
headers:
Link: *59
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78484,9 +78036,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -78510,15 +78062,15 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *331
+ '301': *328
'403': *29
- '410': *527
+ '410': *524
'422': *15
'404': *6
x-github:
@@ -78549,9 +78101,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -78565,13 +78117,13 @@ paths:
application/json:
schema: *75
examples:
- default: *535
- '301': *331
+ default: *532
+ '301': *328
'400': *14
'401': *25
'403': *29
'404': *6
- '410': *527
+ '410': *524
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -78597,9 +78149,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -78611,12 +78163,12 @@ paths:
type: array
items: *75
examples:
- default: *538
+ default: *535
headers:
Link: *59
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -78633,9 +78185,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/events#list-issue-events
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -78649,7 +78201,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &540
+ - &537
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -78703,7 +78255,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &541
+ - &538
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -78839,7 +78391,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &542
+ - &539
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -78890,7 +78442,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &543
+ - &540
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -78941,7 +78493,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &544
+ - &541
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -78995,7 +78547,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &545
+ - &542
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -79042,7 +78594,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &546
+ - &543
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -79089,7 +78641,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &547
+ - &544
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -79149,7 +78701,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &548
+ - &545
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -79197,7 +78749,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &549
+ - &546
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -79263,7 +78815,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &550
+ - &547
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -79329,7 +78881,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &551
+ - &548
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -79395,7 +78947,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &552
+ - &549
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -79486,7 +79038,7 @@ paths:
color: red
headers:
Link: *59
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79503,9 +79055,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -79517,7 +79069,7 @@ paths:
type: array
items: *74
examples:
- default: &539
+ default: &536
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -79535,9 +79087,9 @@ paths:
default: false
headers:
Link: *59
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79554,9 +79106,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -79617,10 +79169,10 @@ paths:
type: array
items: *74
examples:
- default: *539
- '301': *331
+ default: *536
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
'422': *15
x-github:
githubCloudOnly: false
@@ -79637,9 +79189,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -79701,10 +79253,10 @@ paths:
type: array
items: *74
examples:
- default: *539
- '301': *331
+ default: *536
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
'422': *15
x-github:
githubCloudOnly: false
@@ -79721,15 +79273,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
responses:
'204':
description: Response
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79748,9 +79300,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- name: name
in: path
required: true
@@ -79774,9 +79326,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *331
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79796,9 +79348,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#lock-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: false
content:
@@ -79826,7 +79378,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *527
+ '410': *524
'404': *6
'422': *15
x-github:
@@ -79844,9 +79396,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/issues#unlock-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
responses:
'204':
description: Response
@@ -79876,9 +79428,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
responses:
'200':
description: Response
@@ -79886,10 +79438,10 @@ paths:
application/json:
schema: *75
examples:
- default: *535
- '301': *331
+ default: *532
+ '301': *328
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79906,9 +79458,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -79934,13 +79486,13 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *530
+ default: *527
headers:
Link: *59
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -79958,9 +79510,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -79992,16 +79544,16 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'201':
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -80023,10 +79575,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *327
- - *328
- - *536
- - *531
+ - *324
+ - *325
+ - *533
+ - *528
responses:
'204':
description: Response
@@ -80055,9 +79607,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -80081,7 +79633,7 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -80114,9 +79666,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -80128,11 +79680,11 @@ paths:
type: array
items: *75
examples:
- default: *538
+ default: *535
headers:
Link: *59
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80160,9 +79712,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -80191,14 +79743,14 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *527
+ '410': *524
'422': *15
'404': *6
x-github:
@@ -80218,9 +79770,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
requestBody:
required: true
content:
@@ -80253,7 +79805,7 @@ paths:
application/json:
schema: *75
examples:
- default: *535
+ default: *532
'403': *29
'404': *6
'422': *7
@@ -80275,9 +79827,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *327
- - *328
- - *536
+ - *324
+ - *325
+ - *533
- *17
- *19
responses:
@@ -80292,6 +79844,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *537
+ - *538
+ - *539
- *540
- *541
- *542
@@ -80302,9 +79857,6 @@ paths:
- *547
- *548
- *549
- - *550
- - *551
- - *552
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -80613,7 +80165,7 @@ paths:
type: string
comments:
type: array
- items: &574
+ items: &571
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -80828,7 +80380,7 @@ paths:
type: string
comments:
type: array
- items: *458
+ items: *455
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -81117,7 +80669,7 @@ paths:
headers:
Link: *59
'404': *6
- '410': *527
+ '410': *524
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -81134,8 +80686,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -81145,7 +80697,7 @@ paths:
application/json:
schema:
type: array
- items: &553
+ items: &550
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -81211,8 +80763,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -81248,9 +80800,9 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
- default: &554
+ default: &551
value:
id: 1
key: ssh-rsa AAA...
@@ -81284,9 +80836,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *327
- - *328
- - &555
+ - *324
+ - *325
+ - &552
name: key_id
description: The unique identifier of the key.
in: path
@@ -81298,9 +80850,9 @@ paths:
description: Response
content:
application/json:
- schema: *553
+ schema: *550
examples:
- default: *554
+ default: *551
'404': *6
x-github:
githubCloudOnly: false
@@ -81318,9 +80870,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *327
- - *328
- - *555
+ - *324
+ - *325
+ - *552
responses:
'204':
description: Response
@@ -81340,8 +80892,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -81353,7 +80905,7 @@ paths:
type: array
items: *74
examples:
- default: *539
+ default: *536
headers:
Link: *59
'404': *6
@@ -81374,8 +80926,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#create-a-label
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -81413,7 +80965,7 @@ paths:
application/json:
schema: *74
examples:
- default: &556
+ default: &553
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -81445,8 +80997,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#get-a-label
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: name
in: path
required: true
@@ -81459,7 +81011,7 @@ paths:
application/json:
schema: *74
examples:
- default: *556
+ default: *553
'404': *6
x-github:
githubCloudOnly: false
@@ -81476,8 +81028,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#update-a-label
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: name
in: path
required: true
@@ -81542,8 +81094,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#delete-a-label
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: name
in: path
required: true
@@ -81569,8 +81121,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-languages
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -81609,9 +81161,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *327
- - *328
- - *431
+ - *324
+ - *325
+ - *428
responses:
'200':
description: Response
@@ -81756,8 +81308,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -81822,8 +81374,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/branches/branches#merge-a-branch
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -81857,9 +81409,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: *557
+ default: *554
'204':
description: Response when already merged
'404':
@@ -81884,8 +81436,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#list-milestones
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -81926,7 +81478,7 @@ paths:
application/json:
schema:
type: array
- items: &558
+ items: &555
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -81987,8 +81539,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#create-a-milestone
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -82028,9 +81580,9 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: &559
+ default: &556
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -82089,9 +81641,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#get-a-milestone
parameters:
- - *327
- - *328
- - &560
+ - *324
+ - *325
+ - &557
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -82103,9 +81655,9 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: *559
+ default: *556
'404': *6
x-github:
githubCloudOnly: false
@@ -82122,9 +81674,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#update-a-milestone
parameters:
- - *327
- - *328
- - *560
+ - *324
+ - *325
+ - *557
requestBody:
required: false
content:
@@ -82162,9 +81714,9 @@ paths:
description: Response
content:
application/json:
- schema: *558
+ schema: *555
examples:
- default: *559
+ default: *556
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82180,9 +81732,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/milestones#delete-a-milestone
parameters:
- - *327
- - *328
- - *560
+ - *324
+ - *325
+ - *557
responses:
'204':
description: Response
@@ -82203,9 +81755,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *327
- - *328
- - *560
+ - *324
+ - *325
+ - *557
- *17
- *19
responses:
@@ -82217,7 +81769,7 @@ paths:
type: array
items: *74
examples:
- default: *539
+ default: *536
headers:
Link: *59
x-github:
@@ -82236,12 +81788,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *327
- - *328
- - *561
- - *562
+ - *324
+ - *325
+ - *558
+ - *559
- *82
- - *563
+ - *560
- *17
- *19
responses:
@@ -82253,7 +81805,7 @@ paths:
type: array
items: *102
examples:
- default: *564
+ default: *561
headers:
Link: *59
x-github:
@@ -82277,8 +81829,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -82336,14 +81888,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: &565
+ schema: &562
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -82468,7 +82020,7 @@ paths:
- custom_404
- public
examples:
- default: &566
+ default: &563
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -82509,8 +82061,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -82564,9 +82116,9 @@ paths:
description: Response
content:
application/json:
- schema: *565
+ schema: *562
examples:
- default: *566
+ default: *563
'422': *15
'409': *52
x-github:
@@ -82589,8 +82141,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -82689,8 +82241,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -82716,8 +82268,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -82727,7 +82279,7 @@ paths:
application/json:
schema:
type: array
- items: &567
+ items: &564
title: Page Build
description: Page Build
type: object
@@ -82821,8 +82373,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'201':
description: Response
@@ -82867,16 +82419,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-latest-pages-build
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: &568
+ default: &565
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -82924,8 +82476,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: build_id
in: path
required: true
@@ -82936,9 +82488,9 @@ paths:
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: *568
+ default: *565
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82958,8 +82510,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -83064,9 +82616,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *327
- - *328
- - &569
+ - *324
+ - *325
+ - &566
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -83124,9 +82676,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *327
- - *328
- - *569
+ - *324
+ - *325
+ - *566
responses:
'204': *183
'404': *6
@@ -83153,8 +82705,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -83412,8 +82964,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Private vulnerability reporting status
@@ -83450,8 +83002,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204': *183
'422': *14
@@ -83472,8 +83024,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204': *183
'422': *14
@@ -83495,8 +83047,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -83506,7 +83058,7 @@ paths:
type: array
items: *111
examples:
- default: *570
+ default: *567
'403': *29
'404': *6
x-github:
@@ -83528,8 +83080,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -83545,7 +83097,7 @@ paths:
required:
- properties
examples:
- default: *571
+ default: *568
responses:
'204':
description: No Content when custom property values are successfully created
@@ -83583,8 +83135,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -83644,9 +83196,9 @@ paths:
application/json:
schema:
type: array
- items: *465
+ items: *462
examples:
- default: *572
+ default: *569
headers:
Link: *59
'304': *37
@@ -83678,8 +83230,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -83744,7 +83296,7 @@ paths:
description: Response
content:
application/json:
- schema: &576
+ schema: &573
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -83958,7 +83510,7 @@ paths:
- review_comment
- self
author_association: *76
- auto_merge: *573
+ auto_merge: *570
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -84050,7 +83602,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &577
+ default: &574
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -84577,8 +84129,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sort
in: query
required: false
@@ -84607,9 +84159,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: &579
+ default: &576
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -84686,17 +84238,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'200':
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: &575
+ default: &572
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -84771,8 +84323,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -84795,9 +84347,9 @@ paths:
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -84813,8 +84365,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
responses:
'204':
@@ -84836,8 +84388,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
@@ -84864,9 +84416,9 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *530
+ default: *527
headers:
Link: *59
'404': *6
@@ -84887,8 +84439,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
requestBody:
required: true
@@ -84921,16 +84473,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'201':
description: Reaction created
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -84952,10 +84504,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *91
- - *531
+ - *528
responses:
'204':
description: Response
@@ -84998,9 +84550,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request
parameters:
- - *327
- - *328
- - &578
+ - *324
+ - *325
+ - &575
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -85013,9 +84565,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *577
+ default: *574
'304': *37
'404': *6
'406':
@@ -85050,9 +84602,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -85094,9 +84646,9 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *577
+ default: *574
'422': *15
'403': *29
x-github:
@@ -85118,9 +84670,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: true
content:
@@ -85182,7 +84734,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -85190,7 +84742,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'401': *25
'403': *29
'404': *6
@@ -85220,9 +84772,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *99
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -85243,9 +84795,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *579
+ default: *576
headers:
Link: *59
x-github:
@@ -85278,9 +84830,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: true
content:
@@ -85385,7 +84937,7 @@ paths:
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
example-for-a-multi-line-comment:
value:
@@ -85473,9 +85025,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *91
requestBody:
required: true
@@ -85498,7 +85050,7 @@ paths:
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
default:
value:
@@ -85584,9 +85136,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *17
- *19
responses:
@@ -85596,9 +85148,9 @@ paths:
application/json:
schema:
type: array
- items: *461
+ items: *458
examples:
- default: *580
+ default: *577
headers:
Link: *59
x-github:
@@ -85628,9 +85180,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *17
- *19
responses:
@@ -85640,7 +85192,7 @@ paths:
application/json:
schema:
type: array
- items: *474
+ items: *471
examples:
default:
value:
@@ -85678,9 +85230,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
responses:
'204':
description: Response if pull request has been merged
@@ -85703,9 +85255,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -85816,9 +85368,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
responses:
'200':
description: Response
@@ -85893,9 +85445,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -85932,7 +85484,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *462
examples:
default:
value:
@@ -86468,9 +86020,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: true
content:
@@ -86504,7 +86056,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *462
examples:
default:
value:
@@ -87009,9 +86561,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
- *17
- *19
responses:
@@ -87021,7 +86573,7 @@ paths:
application/json:
schema:
type: array
- items: &581
+ items: &578
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -87172,9 +86724,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -87260,9 +86812,9 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
- default: &583
+ default: &580
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -87325,10 +86877,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - &582
+ - *324
+ - *325
+ - *575
+ - &579
name: review_id
description: The unique identifier of the review.
in: path
@@ -87340,9 +86892,9 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
- default: &584
+ default: &581
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -87401,10 +86953,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
requestBody:
required: true
content:
@@ -87427,7 +86979,7 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
default:
value:
@@ -87489,18 +87041,18 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
responses:
'200':
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
- default: *583
+ default: *580
'422': *7
'404': *6
x-github:
@@ -87527,10 +87079,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
- *17
- *19
responses:
@@ -87765,10 +87317,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
requestBody:
required: true
content:
@@ -87796,7 +87348,7 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
default:
value:
@@ -87859,10 +87411,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *327
- - *328
- - *578
- - *582
+ - *324
+ - *325
+ - *575
+ - *579
requestBody:
required: true
content:
@@ -87897,9 +87449,9 @@ paths:
description: Response
content:
application/json:
- schema: *581
+ schema: *578
examples:
- default: *584
+ default: *581
'404': *6
'422': *7
'403': *29
@@ -87921,9 +87473,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *327
- - *328
- - *578
+ - *324
+ - *325
+ - *575
requestBody:
required: false
content:
@@ -87986,8 +87538,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -88000,9 +87552,9 @@ paths:
description: Response
content:
application/json:
- schema: *585
+ schema: *582
examples:
- default: &586
+ default: &583
value:
type: file
encoding: base64
@@ -88044,8 +87596,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: dir
description: The alternate path to look for a README file
in: path
@@ -88065,9 +87617,9 @@ paths:
description: Response
content:
application/json:
- schema: *585
+ schema: *582
examples:
- default: *586
+ default: *583
'404': *6
'422': *15
x-github:
@@ -88089,8 +87641,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#list-releases
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -88100,7 +87652,7 @@ paths:
application/json:
schema:
type: array
- items: *587
+ items: *584
examples:
default:
value:
@@ -88194,8 +87746,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#create-a-release
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -88271,9 +87823,9 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: &591
+ default: &588
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -88378,9 +87930,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#get-a-release-asset
parameters:
- - *327
- - *328
- - &589
+ - *324
+ - *325
+ - &586
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -88392,9 +87944,9 @@ paths:
description: Response
content:
application/json:
- schema: *588
+ schema: *585
examples:
- default: &590
+ default: &587
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1
browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip
@@ -88429,7 +87981,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *476
+ '302': *473
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88445,9 +87997,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#update-a-release-asset
parameters:
- - *327
- - *328
- - *589
+ - *324
+ - *325
+ - *586
requestBody:
required: false
content:
@@ -88475,9 +88027,9 @@ paths:
description: Response
content:
application/json:
- schema: *588
+ schema: *585
examples:
- default: *590
+ default: *587
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88493,9 +88045,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#delete-a-release-asset
parameters:
- - *327
- - *328
- - *589
+ - *324
+ - *325
+ - *586
responses:
'204':
description: Response
@@ -88519,8 +88071,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -88605,16 +88157,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-the-latest-release
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: *591
+ default: *588
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88631,8 +88183,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: tag
description: tag parameter
in: path
@@ -88645,9 +88197,9 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: *591
+ default: *588
'404': *6
x-github:
githubCloudOnly: false
@@ -88669,9 +88221,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#get-a-release
parameters:
- - *327
- - *328
- - &592
+ - *324
+ - *325
+ - &589
name: release_id
description: The unique identifier of the release.
in: path
@@ -88685,9 +88237,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: *591
+ default: *588
'401':
description: Unauthorized
x-github:
@@ -88705,9 +88257,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#update-a-release
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
requestBody:
required: false
content:
@@ -88771,9 +88323,9 @@ paths:
description: Response
content:
application/json:
- schema: *587
+ schema: *584
examples:
- default: *591
+ default: *588
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -88794,9 +88346,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/releases#delete-a-release
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
responses:
'204':
description: Response
@@ -88816,9 +88368,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/releases/assets#list-release-assets
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
- *17
- *19
responses:
@@ -88828,7 +88380,7 @@ paths:
application/json:
schema:
type: array
- items: *588
+ items: *585
examples:
default:
value:
@@ -88909,9 +88461,9 @@ paths:
description: The URL origin (protocol + host name + port) is included in `upload_url`
returned in the response of the "Create a release" endpoint
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
- name: name
in: query
required: true
@@ -88937,7 +88489,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *588
+ schema: *585
examples:
response-for-successful-upload:
value:
@@ -88992,9 +88544,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
- name: content
description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -89018,9 +88570,9 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *530
+ default: *527
headers:
Link: *59
'404': *6
@@ -89041,9 +88593,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *327
- - *328
- - *592
+ - *324
+ - *325
+ - *589
requestBody:
required: true
content:
@@ -89073,16 +88625,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'201':
description: Reaction created
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *15
x-github:
githubCloudOnly: false
@@ -89104,10 +88656,10 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *327
- - *328
- - *592
- - *531
+ - *324
+ - *325
+ - *589
+ - *528
responses:
'204':
description: Response
@@ -89131,9 +88683,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *327
- - *328
- - *394
+ - *324
+ - *325
+ - *391
- *17
- *19
responses:
@@ -89150,7 +88702,7 @@ paths:
oneOf:
- allOf:
- *286
- - &593
+ - &590
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -89171,67 +88723,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *287
- - *593
+ - *590
- allOf:
- *288
- - *593
+ - *590
- allOf:
- *289
- - *593
+ - *590
- allOf:
- - *594
- - *593
+ - *591
+ - *590
- allOf:
- *290
- - *593
+ - *590
- allOf:
- *291
- - *593
+ - *590
- allOf:
- *292
- - *593
+ - *590
- allOf:
- *293
- - *593
+ - *590
- allOf:
- *294
- - *593
+ - *590
- allOf:
- *295
- - *593
+ - *590
- allOf:
- *296
- - *593
+ - *590
- allOf:
- *297
- - *593
+ - *590
- allOf:
- *298
- - *593
+ - *590
- allOf:
- *299
- - *593
+ - *590
- allOf:
- *300
- - *593
+ - *590
- allOf:
- *301
- - *593
+ - *590
- allOf:
- *302
- - *593
+ - *590
- allOf:
- *303
- - *593
+ - *590
- allOf:
- *304
- - *593
+ - *590
- allOf:
- *305
- - *593
+ - *590
- allOf:
- *306
- - *593
+ - *590
examples:
default:
value:
@@ -89270,8 +88822,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
- name: includes_parents
@@ -89282,7 +88834,7 @@ paths:
schema:
type: boolean
default: true
- - *595
+ - *592
responses:
'200':
description: Response
@@ -89337,8 +88889,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
description: Request body
required: true
@@ -89367,7 +88919,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *596
+ items: *593
required:
- name
- enforcement
@@ -89400,7 +88952,7 @@ paths:
application/json:
schema: *307
examples:
- default: &606
+ default: &603
value:
id: 42
name: super cool ruleset
@@ -89447,12 +88999,12 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *327
- - *328
+ - *324
+ - *325
+ - *594
+ - *595
+ - *596
- *597
- - *598
- - *599
- - *600
- *17
- *19
responses:
@@ -89460,9 +89012,9 @@ paths:
description: Response
content:
application/json:
- schema: *601
+ schema: *598
examples:
- default: *602
+ default: *599
'404': *6
'500': *112
x-github:
@@ -89483,17 +89035,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *327
- - *328
- - *603
+ - *324
+ - *325
+ - *600
responses:
'200':
description: Response
content:
application/json:
- schema: *604
+ schema: *601
examples:
- default: *605
+ default: *602
'404': *6
'500': *112
x-github:
@@ -89521,8 +89073,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89544,7 +89096,7 @@ paths:
application/json:
schema: *307
examples:
- default: *606
+ default: *603
'404': *6
'500': *112
put:
@@ -89562,8 +89114,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89597,7 +89149,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *596
+ items: *593
examples:
default:
value:
@@ -89627,7 +89179,7 @@ paths:
application/json:
schema: *307
examples:
- default: *606
+ default: *603
'404': *6
'500': *112
delete:
@@ -89645,8 +89197,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89669,8 +89221,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
- name: ruleset_id
@@ -89688,7 +89240,7 @@ paths:
type: array
items: *310
examples:
- default: *607
+ default: *604
'404': *6
'500': *112
x-github:
@@ -89707,8 +89259,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -89726,7 +89278,7 @@ paths:
description: Response
content:
application/json:
- schema: *608
+ schema: *605
examples:
default:
value:
@@ -89781,22 +89333,22 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
+ - *606
+ - *607
+ - *608
- *609
- *610
- - *611
- - *612
- - *613
- *53
- *19
- *17
+ - *611
+ - *612
+ - *613
- *614
- *615
- *616
- - *617
- - *618
- - *619
responses:
'200':
description: Response
@@ -89804,7 +89356,7 @@ paths:
application/json:
schema:
type: array
- items: &623
+ items: &620
type: object
properties:
number: *170
@@ -89823,8 +89375,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *620
- resolution: *621
+ state: *617
+ resolution: *618
resolved_at:
type: string
format: date-time
@@ -89920,7 +89472,7 @@ paths:
pull request.
'
- oneOf: *622
+ oneOf: *619
nullable: true
has_more_locations:
type: boolean
@@ -90069,16 +89621,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *327
- - *328
- - *425
- - *619
+ - *324
+ - *325
+ - *422
+ - *616
responses:
'200':
description: Response
content:
application/json:
- schema: *623
+ schema: *620
examples:
default:
value:
@@ -90132,9 +89684,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
requestBody:
required: true
content:
@@ -90142,8 +89694,8 @@ paths:
schema:
type: object
properties:
- state: *620
- resolution: *621
+ state: *617
+ resolution: *618
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -90177,7 +89729,7 @@ paths:
description: Response
content:
application/json:
- schema: *623
+ schema: *620
examples:
default:
value:
@@ -90272,9 +89824,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *327
- - *328
- - *425
+ - *324
+ - *325
+ - *422
- *19
- *17
responses:
@@ -90285,7 +89837,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &781
+ items: &776
type: object
properties:
type:
@@ -90311,6 +89863,9 @@ paths:
example: commit
details:
oneOf:
+ - *621
+ - *622
+ - *623
- *624
- *625
- *626
@@ -90321,9 +89876,6 @@ paths:
- *631
- *632
- *633
- - *634
- - *635
- - *636
examples:
default:
value:
@@ -90409,8 +89961,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -90418,14 +89970,14 @@ paths:
schema:
type: object
properties:
- reason: &638
+ reason: &635
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *637
+ placeholder_id: *634
required:
- reason
- placeholder_id
@@ -90442,7 +89994,7 @@ paths:
schema:
type: object
properties:
- reason: *638
+ reason: *635
expire_at:
type: string
format: date-time
@@ -90488,8 +90040,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -90504,7 +90056,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &639
+ items: &636
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -90530,15 +90082,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *639
+ items: *636
backfill_scans:
type: array
- items: *639
+ items: *636
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *639
+ - *636
- type: object
properties:
pattern_name:
@@ -90608,8 +90160,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *53
- name: sort
description: The property to sort the results by.
@@ -90653,9 +90205,9 @@ paths:
application/json:
schema:
type: array
- items: *640
+ items: *637
examples:
- default: *641
+ default: *638
'400': *14
'404': *6
x-github:
@@ -90678,8 +90230,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -90839,9 +90391,9 @@ paths:
description: Response
content:
application/json:
- schema: *640
+ schema: *637
examples:
- default: &643
+ default: &640
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -91074,8 +90626,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -91179,7 +90731,7 @@ paths:
description: Response
content:
application/json:
- schema: *640
+ schema: *637
examples:
default:
value:
@@ -91326,17 +90878,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *327
- - *328
- - *642
+ - *324
+ - *325
+ - *639
responses:
'200':
description: Response
content:
application/json:
- schema: *640
+ schema: *637
examples:
- default: *643
+ default: *640
'403': *29
'404': *6
x-github:
@@ -91360,9 +90912,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *327
- - *328
- - *642
+ - *324
+ - *325
+ - *639
requestBody:
required: true
content:
@@ -91521,10 +91073,10 @@ paths:
description: Response
content:
application/json:
- schema: *640
+ schema: *637
examples:
- default: *643
- add_credit: *643
+ default: *640
+ add_credit: *640
'403': *29
'404': *6
'422':
@@ -91562,9 +91114,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- - *327
- - *328
- - *642
+ - *324
+ - *325
+ - *639
responses:
'202': *39
'400': *14
@@ -91591,17 +91143,17 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork
parameters:
- - *327
- - *328
- - *642
+ - *324
+ - *325
+ - *639
responses:
'202':
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
+ default: *329
'400': *14
'422': *15
'403': *29
@@ -91627,8 +91179,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-stargazers
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -91727,8 +91279,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -91737,7 +91289,7 @@ paths:
application/json:
schema:
type: array
- items: &644
+ items: &641
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -91770,8 +91322,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -91847,8 +91399,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -91944,8 +91496,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -92099,8 +91651,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -92110,7 +91662,7 @@ paths:
application/json:
schema:
type: array
- items: *644
+ items: *641
examples:
default:
value:
@@ -92143,8 +91695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/commits/statuses#create-a-commit-status
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: sha
in: path
required: true
@@ -92198,7 +91750,7 @@ paths:
description: Response
content:
application/json:
- schema: *645
+ schema: *642
examples:
default:
value:
@@ -92252,8 +91804,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#list-watchers
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -92285,14 +91837,14 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &646
+ schema: &643
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -92360,8 +91912,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -92387,7 +91939,7 @@ paths:
description: Response
content:
application/json:
- schema: *646
+ schema: *643
examples:
default:
value:
@@ -92414,8 +91966,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -92435,8 +91987,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-tags
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -92515,8 +92067,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -92524,7 +92076,7 @@ paths:
application/json:
schema:
type: array
- items: &647
+ items: &644
title: Tag protection
description: Tag protection
type: object
@@ -92576,8 +92128,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:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -92600,7 +92152,7 @@ paths:
description: Response
content:
application/json:
- schema: *647
+ schema: *644
examples:
default:
value:
@@ -92631,8 +92183,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:
- - *327
- - *328
+ - *324
+ - *325
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -92669,8 +92221,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ref
in: path
required: true
@@ -92706,8 +92258,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#list-repository-teams
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *17
- *19
responses:
@@ -92739,8 +92291,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#get-all-repository-topics
parameters:
- - *327
- - *328
+ - *324
+ - *325
- *19
- *17
responses:
@@ -92748,7 +92300,7 @@ paths:
description: Response
content:
application/json:
- schema: &648
+ schema: &645
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -92760,7 +92312,7 @@ paths:
required:
- names
examples:
- default: &649
+ default: &646
value:
names:
- octocat
@@ -92783,8 +92335,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -92815,9 +92367,9 @@ paths:
description: Response
content:
application/json:
- schema: *648
+ schema: *645
examples:
- default: *649
+ default: *646
'404': *6
'422': *7
x-github:
@@ -92838,9 +92390,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-repository-clones
parameters:
- - *327
- - *328
- - &650
+ - *324
+ - *325
+ - &647
name: per
description: The time frame to display results for.
in: query
@@ -92869,7 +92421,7 @@ paths:
example: 128
clones:
type: array
- items: &651
+ items: &648
title: Traffic
type: object
properties:
@@ -92956,8 +92508,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -93047,8 +92599,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'200':
description: Response
@@ -93108,9 +92660,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/metrics/traffic#get-page-views
parameters:
- - *327
- - *328
- - *650
+ - *324
+ - *325
+ - *647
responses:
'200':
description: Response
@@ -93129,7 +92681,7 @@ paths:
example: 3782
views:
type: array
- items: *651
+ items: *648
required:
- uniques
- count
@@ -93206,8 +92758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#transfer-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
requestBody:
required: true
content:
@@ -93481,8 +93033,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -93505,8 +93057,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -93528,8 +93080,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -93555,8 +93107,8 @@ paths:
url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *327
- - *328
+ - *324
+ - *325
- name: ref
in: path
required: true
@@ -93648,9 +93200,9 @@ paths:
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
+ default: *329
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -93898,7 +93450,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &652
+ text_matches: &649
title: Search Result Text Matches
type: array
items:
@@ -94060,7 +93612,7 @@ paths:
enum:
- author-date
- committer-date
- - &653
+ - &650
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
@@ -94131,7 +93683,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *392
+ properties: *389
nullable: true
comment_count:
type: integer
@@ -94151,7 +93703,7 @@ paths:
url:
type: string
format: uri
- verification: *513
+ verification: *510
required:
- author
- committer
@@ -94170,7 +93722,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *392
+ properties: *389
nullable: true
parents:
type: array
@@ -94188,7 +93740,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *652
+ text_matches: *649
required:
- sha
- node_id
@@ -94380,7 +93932,7 @@ paths:
- interactions
- created
- updated
- - *653
+ - *650
- *17
- *19
- name: advanced_search
@@ -94477,11 +94029,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
type: string
state_reason:
@@ -94513,7 +94065,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *652
+ text_matches: *649
pull_request:
type: object
properties:
@@ -94738,7 +94290,7 @@ paths:
enum:
- created
- updated
- - *653
+ - *650
- *17
- *19
responses:
@@ -94782,7 +94334,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *652
+ text_matches: *649
required:
- id
- node_id
@@ -94867,7 +94419,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *653
+ - *650
- *17
- *19
responses:
@@ -95106,7 +94658,7 @@ paths:
- admin
- pull
- push
- text_matches: *652
+ text_matches: *649
temp_clone_token:
type: string
allow_merge_commit:
@@ -95406,7 +94958,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *652
+ text_matches: *649
related:
type: array
nullable: true
@@ -95597,7 +95149,7 @@ paths:
- followers
- repositories
- joined
- - *653
+ - *650
- *17
- *19
responses:
@@ -95701,7 +95253,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *652
+ text_matches: *649
blog:
type: string
nullable: true
@@ -95780,7 +95332,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#get-a-team-legacy
parameters:
- - &657
+ - &654
name: team_id
description: The unique identifier of the team.
in: path
@@ -95821,7 +95373,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#update-a-team-legacy
parameters:
- - *657
+ - *654
requestBody:
required: true
content:
@@ -95921,7 +95473,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy
parameters:
- - *657
+ - *654
responses:
'204':
description: Response
@@ -95935,226 +95487,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy
- parameters:
- - *657
- - *53
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *323
- examples:
- default: *658
- headers:
- Link: *59
- 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]
- > **Endpoint closing down notice:** 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.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - *657
- 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: *323
- examples:
- default: *324
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - *657
- - *325
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *323
- examples:
- default: *324
- 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]
- > **Endpoint closing down notice:** 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.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth 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:
- - *657
- - *325
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *323
- examples:
- default: *659
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - *657
- - *325
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -96170,7 +95502,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *657
+ - *654
- *17
- *19
responses:
@@ -96208,7 +95540,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#list-team-members-legacy
parameters:
- - *657
+ - *654
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -96259,7 +95591,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-member-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'204':
@@ -96296,7 +95628,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-team-member-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'204':
@@ -96336,7 +95668,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-member-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'204':
@@ -96373,16 +95705,16 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'200':
description: Response
content:
application/json:
- schema: *326
+ schema: *323
examples:
- response-if-user-is-a-team-maintainer: *660
+ response-if-user-is-a-team-maintainer: *655
'404': *6
x-github:
githubCloudOnly: false
@@ -96415,7 +95747,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *657
+ - *654
- *64
requestBody:
required: false
@@ -96441,9 +95773,9 @@ paths:
description: Response
content:
application/json:
- schema: *326
+ schema: *323
examples:
- response-if-users-membership-with-team-is-now-pending: *661
+ response-if-users-membership-with-team-is-now-pending: *656
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -96477,7 +95809,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *657
+ - *654
- *64
responses:
'204':
@@ -96505,7 +95837,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy
parameters:
- - *657
+ - *654
- *17
- *19
responses:
@@ -96547,15 +95879,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *657
- - *327
- - *328
+ - *654
+ - *324
+ - *325
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *662
+ schema: *657
examples:
alternative-response-with-extra-repository-information:
value:
@@ -96706,9 +96038,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *657
- - *327
- - *328
+ - *654
+ - *324
+ - *325
requestBody:
required: false
content:
@@ -96758,9 +96090,9 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *657
- - *327
- - *328
+ - *654
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -96785,7 +96117,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy
parameters:
- - *657
+ - *654
- *17
- *19
responses:
@@ -96797,7 +96129,7 @@ paths:
type: array
items: *189
examples:
- response-if-child-teams-exist: *663
+ response-if-child-teams-exist: *658
headers:
Link: *59
'404': *6
@@ -96830,7 +96162,7 @@ paths:
application/json:
schema:
oneOf:
- - &665
+ - &660
title: Private User
description: Private User
type: object
@@ -97033,7 +96365,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *664
+ - *659
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -97186,7 +96518,7 @@ paths:
description: Response
content:
application/json:
- schema: *665
+ schema: *660
examples:
default:
value:
@@ -97532,7 +96864,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -97540,7 +96872,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'401': *25
'403': *29
'404': *6
@@ -97584,7 +96916,7 @@ paths:
type: integer
secrets:
type: array
- items: &666
+ items: &661
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -97624,7 +96956,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *451
+ default: *448
headers:
Link: *59
x-github:
@@ -97700,7 +97032,7 @@ paths:
description: Response
content:
application/json:
- schema: *666
+ schema: *661
examples:
default:
value:
@@ -97846,7 +97178,7 @@ paths:
type: array
items: *152
examples:
- default: *667
+ default: *662
'401': *25
'403': *29
'404': *6
@@ -97998,7 +97330,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'304': *37
'500': *112
'401': *25
@@ -98056,7 +97388,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'401': *25
'403': *29
'404': *6
@@ -98113,7 +97445,7 @@ paths:
description: Response
content:
application/json:
- schema: &668
+ schema: &663
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -98154,7 +97486,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &669
+ default: &664
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -98199,9 +97531,9 @@ paths:
description: Response
content:
application/json:
- schema: *668
+ schema: *663
examples:
- default: *669
+ default: *664
'404': *6
x-github:
githubCloudOnly: false
@@ -98238,9 +97570,9 @@ paths:
type: integer
machines:
type: array
- items: *670
+ items: *665
examples:
- default: *671
+ default: *666
'304': *37
'500': *112
'401': *25
@@ -98319,13 +97651,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *330
+ repository: *327
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *449
- required: *450
+ properties: *446
+ required: *447
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -99107,7 +98439,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'304': *37
'500': *112
'400': *14
@@ -99147,7 +98479,7 @@ paths:
application/json:
schema: *232
examples:
- default: *448
+ default: *445
'500': *112
'401': *25
'403': *29
@@ -99179,7 +98511,7 @@ paths:
type: array
items: *245
examples:
- default: &682
+ default: &677
value:
- id: 197
name: hello_docker
@@ -99280,7 +98612,7 @@ paths:
application/json:
schema:
type: array
- items: &672
+ items: &667
title: Email
description: Email
type: object
@@ -99345,9 +98677,9 @@ paths:
application/json:
schema:
type: array
- items: *672
+ items: *667
examples:
- default: &684
+ default: &679
value:
- email: octocat@github.com
verified: true
@@ -99422,7 +98754,7 @@ paths:
application/json:
schema:
type: array
- items: *672
+ items: *667
examples:
default:
value:
@@ -99678,7 +99010,7 @@ paths:
application/json:
schema:
type: array
- items: &673
+ items: &668
title: GPG Key
description: A unique encryption key
type: object
@@ -99809,7 +99141,7 @@ paths:
- subkeys
- revoked
examples:
- default: &698
+ default: &693
value:
- id: 3
name: Octocat's GPG Key
@@ -99894,9 +99226,9 @@ paths:
description: Response
content:
application/json:
- schema: *673
+ schema: *668
examples:
- default: &674
+ default: &669
value:
id: 3
name: Octocat's GPG Key
@@ -99953,7 +99285,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &675
+ - &670
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -99965,9 +99297,9 @@ paths:
description: Response
content:
application/json:
- schema: *673
+ schema: *668
examples:
- default: *674
+ default: *669
'404': *6
'304': *37
'403': *29
@@ -99990,7 +99322,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *675
+ - *670
responses:
'204':
description: Response
@@ -100295,7 +99627,7 @@ paths:
required: true
content:
application/json:
- schema: *524
+ schema: *521
examples:
default:
value:
@@ -100445,7 +99777,7 @@ paths:
application/json:
schema:
type: array
- items: &676
+ items: &671
title: Key
description: Key
type: object
@@ -100546,9 +99878,9 @@ paths:
description: Response
content:
application/json:
- schema: *676
+ schema: *671
examples:
- default: &677
+ default: &672
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -100581,15 +99913,15 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *555
+ - *552
responses:
'200':
description: Response
content:
application/json:
- schema: *676
+ schema: *671
examples:
- default: *677
+ default: *672
'404': *6
'304': *37
'403': *29
@@ -100612,7 +99944,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *555
+ - *552
responses:
'204':
description: Response
@@ -100645,7 +99977,7 @@ paths:
application/json:
schema:
type: array
- items: &678
+ items: &673
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -100713,7 +100045,7 @@ paths:
- account
- plan
examples:
- default: &679
+ default: &674
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -100775,9 +100107,9 @@ paths:
application/json:
schema:
type: array
- items: *678
+ items: *673
examples:
- default: *679
+ default: *674
headers:
Link: *59
'304': *37
@@ -101786,7 +101118,7 @@ paths:
url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository
parameters:
- *239
- - *680
+ - *675
responses:
'204':
description: Response
@@ -101901,7 +101233,7 @@ paths:
- docker
- nuget
- container
- - *681
+ - *676
- *19
- *17
responses:
@@ -101913,8 +101245,8 @@ paths:
type: array
items: *245
examples:
- default: *682
- '400': *683
+ default: *677
+ '400': *678
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -101943,7 +101275,7 @@ paths:
application/json:
schema: *245
examples:
- default: &699
+ default: &694
value:
id: 40201
name: octo-name
@@ -102305,9 +101637,9 @@ paths:
application/json:
schema:
type: array
- items: *672
+ items: *667
examples:
- default: *684
+ default: *679
headers:
Link: *59
'304': *37
@@ -102420,7 +101752,7 @@ paths:
type: array
items: *71
examples:
- default: &691
+ default: &686
summary: Default response
value:
- id: 1296269
@@ -102724,9 +102056,9 @@ paths:
description: Response
content:
application/json:
- schema: *330
+ schema: *327
examples:
- default: *332
+ default: *329
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -102764,9 +102096,9 @@ paths:
application/json:
schema:
type: array
- items: *526
+ items: *523
examples:
- default: *685
+ default: *680
headers:
Link: *59
'304': *37
@@ -102845,7 +102177,7 @@ paths:
application/json:
schema:
type: array
- items: &686
+ items: &681
title: Social account
description: Social media account
type: object
@@ -102860,7 +102192,7 @@ paths:
- provider
- url
examples:
- default: &687
+ default: &682
value:
- provider: twitter
url: https://twitter.com/github
@@ -102922,9 +102254,9 @@ paths:
application/json:
schema:
type: array
- items: *686
+ items: *681
examples:
- default: *687
+ default: *682
'422': *15
'304': *37
'404': *6
@@ -103011,7 +102343,7 @@ paths:
application/json:
schema:
type: array
- items: &688
+ items: &683
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -103031,7 +102363,7 @@ paths:
- title
- created_at
examples:
- default: &717
+ default: &712
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -103095,9 +102427,9 @@ paths:
description: Response
content:
application/json:
- schema: *688
+ schema: *683
examples:
- default: &689
+ default: &684
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -103127,7 +102459,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &690
+ - &685
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -103139,9 +102471,9 @@ paths:
description: Response
content:
application/json:
- schema: *688
+ schema: *683
examples:
- default: *689
+ default: *684
'404': *6
'304': *37
'403': *29
@@ -103164,7 +102496,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *690
+ - *685
responses:
'204':
description: Response
@@ -103193,7 +102525,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &718
+ - &713
name: sort
description: The property to sort the results by. `created` means when the
repository was starred. `updated` means when the repository was last pushed
@@ -103218,11 +102550,11 @@ paths:
type: array
items: *71
examples:
- default-response: *691
+ default-response: *686
application/vnd.github.v3.star+json:
schema:
type: array
- items: &719
+ items: &714
title: Starred Repository
description: Starred Repository
type: object
@@ -103378,8 +102710,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:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response if this repository is starred by you
@@ -103407,8 +102739,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -103432,8 +102764,8 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *327
- - *328
+ - *324
+ - *325
responses:
'204':
description: Response
@@ -103591,10 +102923,10 @@ paths:
application/json:
schema:
oneOf:
- - *665
- - *664
+ - *660
+ - *659
examples:
- default-response: &693
+ default-response: &688
summary: Default response
value:
login: octocat
@@ -103629,7 +102961,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &694
+ response-with-git-hub-plan-information: &689
summary: Response with GitHub plan information
value:
login: octocat
@@ -103751,7 +103083,7 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/users/users#list-users
parameters:
- - *692
+ - *687
- *17
responses:
'200':
@@ -103800,11 +103132,11 @@ paths:
application/json:
schema:
oneOf:
- - *665
- - *664
+ - *660
+ - *659
examples:
- default-response: *693
- response-with-git-hub-plan-information: *694
+ default-response: *688
+ response-with-git-hub-plan-information: *689
'404': *6
x-github:
githubCloudOnly: false
@@ -103854,8 +103186,8 @@ paths:
required:
- subject_digests
examples:
- default: *695
- withPredicateType: *696
+ default: *690
+ withPredicateType: *691
responses:
'200':
description: Response
@@ -103908,7 +103240,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *697
+ default: *692
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -104113,7 +103445,7 @@ paths:
initiator:
type: string
examples:
- default: *388
+ default: *385
'201':
description: Response
content:
@@ -104154,7 +103486,7 @@ paths:
type: array
items: *245
examples:
- default: *682
+ default: *677
'403': *29
'401': *25
x-github:
@@ -104538,9 +103870,9 @@ paths:
application/json:
schema:
type: array
- items: *673
+ items: *668
examples:
- default: *698
+ default: *693
headers:
Link: *59
x-github:
@@ -104644,7 +103976,7 @@ paths:
application/json:
schema: *22
examples:
- default: *523
+ default: *520
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -104768,7 +104100,7 @@ paths:
- docker
- nuget
- container
- - *681
+ - *676
- *64
- *19
- *17
@@ -104781,10 +104113,10 @@ paths:
type: array
items: *245
examples:
- default: *682
+ default: *677
'403': *29
'401': *25
- '400': *683
+ '400': *678
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -104814,7 +104146,7 @@ paths:
application/json:
schema: *245
examples:
- default: *699
+ default: *694
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -105163,7 +104495,7 @@ paths:
type: array
items: *267
examples:
- default: *700
+ default: *695
headers:
Link: *59
'304': *37
@@ -105223,7 +104555,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *701
+ items: *696
required:
- name
- data_type
@@ -105239,7 +104571,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *702
+ iteration_configuration: *697
required:
- name
- data_type
@@ -105261,8 +104593,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *703
- iteration_field: *704
+ single_select_field: *698
+ iteration_field: *699
responses:
'201':
description: Response
@@ -105270,11 +104602,11 @@ paths:
application/json:
schema: *267
examples:
- text_field: *705
- number_field: *706
- date_field: *707
- single_select_field: *708
- iteration_field: *709
+ text_field: *700
+ number_field: *701
+ date_field: *702
+ single_select_field: *703
+ iteration_field: *704
'304': *37
'403': *29
'401': *25
@@ -105296,7 +104628,7 @@ paths:
url: https://docs.github.com/rest/projects/fields#get-project-field-for-user
parameters:
- *263
- - *710
+ - *705
- *64
responses:
'200':
@@ -105305,7 +104637,7 @@ paths:
application/json:
schema: *267
examples:
- default: *711
+ default: *706
headers:
Link: *59
'304': *37
@@ -105659,7 +104991,7 @@ paths:
parameters:
- *263
- *64
- - *712
+ - *707
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -105934,7 +105266,7 @@ paths:
- *115
- *117
- *116
- - *713
+ - *708
- *118
responses:
'200':
@@ -106065,7 +105397,7 @@ paths:
parameters:
- *64
- *115
- - *714
+ - *709
- *116
responses:
'200':
@@ -106164,9 +105496,9 @@ paths:
- *115
- *117
- *116
- - *715
+ - *710
- *118
- - *716
+ - *711
responses:
'200':
description: Response when getting a billing usage summary
@@ -106300,9 +105632,9 @@ paths:
application/json:
schema:
type: array
- items: *686
+ items: *681
examples:
- default: *687
+ default: *682
headers:
Link: *59
x-github:
@@ -106332,9 +105664,9 @@ paths:
application/json:
schema:
type: array
- items: *688
+ items: *683
examples:
- default: *717
+ default: *712
headers:
Link: *59
x-github:
@@ -106359,7 +105691,7 @@ paths:
url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *64
- - *718
+ - *713
- *53
- *17
- *19
@@ -106371,11 +105703,11 @@ paths:
schema:
anyOf:
- type: array
- items: *719
+ items: *714
- type: array
items: *71
examples:
- default-response: *691
+ default-response: *686
headers:
Link: *59
x-github:
@@ -106534,7 +105866,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &720
+ enterprise: &715
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -106592,7 +105924,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &721
+ installation: &716
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -106611,7 +105943,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &722
+ organization: &717
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -106671,13 +106003,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &723
+ repository: &718
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: &753
+ properties: &748
id:
description: Unique identifier of the repository
example: 42
@@ -107360,7 +106692,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &754
+ required: &749
- archive_url
- assignees_url
- blobs_url
@@ -107511,10 +106843,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -107590,11 +106922,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- rule: &724
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ rule: &719
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -107817,11 +107149,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- rule: *724
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ rule: *719
sender: *4
required:
- action
@@ -108004,11 +107336,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- rule: *724
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ rule: *719
sender: *4
required:
- action
@@ -108092,7 +107424,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &726
+ check_run: &721
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -108183,7 +107515,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *725
+ deployment: *720
details_url:
example: https://example.com
type: string
@@ -108268,10 +107600,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *721
- enterprise: *720
- organization: *722
- repository: *723
+ installation: *716
+ enterprise: *715
+ organization: *717
+ repository: *718
sender: *4
required:
- check_run
@@ -108664,11 +107996,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *726
- installation: *721
- enterprise: *720
- organization: *722
- repository: *723
+ check_run: *721
+ installation: *716
+ enterprise: *715
+ organization: *717
+ repository: *718
sender: *4
required:
- check_run
@@ -109064,11 +108396,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *726
- installation: *721
- enterprise: *720
- organization: *722
- repository: *723
+ check_run: *721
+ installation: *716
+ enterprise: *715
+ organization: *717
+ repository: *718
requested_action:
description: The action requested by the user.
type: object
@@ -109473,11 +108805,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *726
- installation: *721
- enterprise: *720
- organization: *722
- repository: *723
+ check_run: *721
+ installation: *716
+ enterprise: *715
+ organization: *717
+ repository: *718
sender: *4
required:
- check_run
@@ -110454,10 +109786,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -111151,10 +110483,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -111842,10 +111174,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -112011,7 +111343,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -112156,20 +111488,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &727
+ commit_oid: &722
description: The commit SHA of the code scanning alert. When the
action is `reopened_by_user` or `closed_by_user`, the event was
triggered by the `sender` and this value will be empty.
type: string
- enterprise: *720
- installation: *721
- organization: *722
- ref: &728
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: &723
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -112334,7 +111666,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -112564,12 +111896,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *727
- enterprise: *720
- installation: *721
- organization: *722
- ref: *728
- repository: *723
+ commit_oid: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: *723
+ repository: *718
sender: *4
required:
- action
@@ -112664,7 +111996,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -112835,12 +112167,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *727
- enterprise: *720
- installation: *721
- organization: *722
- ref: *728
- repository: *723
+ commit_oid: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: *723
+ repository: *718
sender: *4
required:
- action
@@ -113006,7 +112338,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -113172,12 +112504,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *727
- enterprise: *720
- installation: *721
- organization: *722
- ref: *728
- repository: *723
+ commit_oid: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: *723
+ repository: *718
sender: *4
required:
- action
@@ -113276,7 +112608,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -113451,16 +112783,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
nullable: true
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -113557,7 +112889,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -113697,12 +113029,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *727
- enterprise: *720
- installation: *721
- organization: *722
- ref: *728
- repository: *723
+ commit_oid: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
+ ref: *723
+ repository: *718
sender: *4
required:
- action
@@ -113868,7 +113200,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *420
+ dismissed_comment: *417
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -114013,10 +113345,10 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -114271,10 +113603,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -114354,18 +113686,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *722
- pusher_type: &729
+ organization: *717
+ pusher_type: &724
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &730
+ ref: &725
description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference)
resource.
type: string
@@ -114375,7 +113707,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *723
+ repository: *718
sender: *4
required:
- ref
@@ -114458,9 +113790,9 @@ x-webhooks:
enum:
- created
definition: *274
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -114545,9 +113877,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -114625,9 +113957,9 @@ x-webhooks:
enum:
- promote_to_enterprise
definition: *274
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -114705,9 +114037,9 @@ x-webhooks:
enum:
- updated
definition: *274
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -114784,10 +114116,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *720
- installation: *721
- repository: *723
- organization: *722
+ enterprise: *715
+ installation: *716
+ repository: *718
+ organization: *717
sender: *4
new_property_values:
type: array
@@ -114872,18 +114204,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
- pusher_type: *729
- ref: *730
+ enterprise: *715
+ installation: *716
+ organization: *717
+ pusher_type: *724
+ ref: *725
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *723
+ repository: *718
sender: *4
required:
- ref
@@ -114967,11 +114299,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115055,11 +114387,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115143,11 +114475,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115229,11 +114561,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115315,11 +114647,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115402,11 +114734,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115488,11 +114820,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *482
- installation: *721
- organization: *722
- enterprise: *720
- repository: *723
+ alert: *479
+ installation: *716
+ organization: *717
+ enterprise: *715
+ repository: *718
sender: *4
required:
- action
@@ -115569,9 +114901,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- key: &731
+ enterprise: *715
+ installation: *716
+ key: &726
description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -115607,8 +114939,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -115685,11 +115017,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- key: *731
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ key: *726
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -116250,12 +115582,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: &735
+ workflow: &730
title: Workflow
type: object
nullable: true
@@ -116981,13 +116313,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *488
+ deployment: *485
pull_requests:
type: array
- items: *576
- repository: *723
- organization: *722
- installation: *721
+ items: *573
+ repository: *718
+ organization: *717
+ installation: *716
sender: *4
responses:
'200':
@@ -117058,7 +116390,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &732
+ approver: &727
type: object
properties:
avatar_url:
@@ -117101,11 +116433,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- reviewers: &733
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ reviewers: &728
type: array
items:
type: object
@@ -117184,7 +116516,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &734
+ workflow_job_run: &729
type: object
properties:
conclusion:
@@ -117915,18 +117247,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *732
+ approver: *727
comment:
type: string
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- reviewers: *733
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ reviewers: *728
sender: *4
since:
type: string
- workflow_job_run: *734
+ workflow_job_run: *729
workflow_job_runs:
type: array
items:
@@ -118630,13 +117962,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *720
+ enterprise: *715
environment:
type: string
- installation: *721
- organization: *722
- repository: *723
- requestor: &740
+ installation: *716
+ organization: *717
+ repository: *718
+ requestor: &735
title: User
type: object
nullable: true
@@ -120535,12 +119867,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: *735
+ workflow: *730
workflow_run:
title: Deployment Workflow Run
type: object
@@ -121220,7 +120552,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &738
+ answer: &733
type: object
properties:
author_association:
@@ -121377,11 +120709,11 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -121508,11 +120840,11 @@ x-webhooks:
- from
required:
- category
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -121595,11 +120927,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -121681,7 +121013,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &737
+ comment: &732
type: object
properties:
author_association:
@@ -121838,11 +121170,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -121925,12 +121257,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *737
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ comment: *732
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122025,12 +121357,12 @@ x-webhooks:
- from
required:
- body
- comment: *737
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ comment: *732
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122114,11 +121446,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122200,11 +121532,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122304,11 +121636,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122390,10 +121722,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *736
- enterprise: *720
- installation: *721
- label: &739
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ label: &734
title: Label
type: object
properties:
@@ -122425,8 +121757,8 @@ x-webhooks:
- color
- default
- description
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122509,11 +121841,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122595,11 +121927,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122681,11 +122013,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122770,16 +122102,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *736
- new_repository: *723
+ new_discussion: *731
+ new_repository: *718
required:
- new_discussion
- new_repository
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122862,10 +122194,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *736
- old_answer: *738
- organization: *722
- repository: *723
+ discussion: *731
+ old_answer: *733
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -122947,12 +122279,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *736
- enterprise: *720
- installation: *721
- label: *739
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -123035,11 +122367,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -123121,11 +122453,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *736
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ discussion: *731
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -123198,7 +122530,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *720
+ enterprise: *715
forkee:
description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository)
resource.
@@ -123858,9 +123190,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- forkee
@@ -124006,9 +123338,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pages:
description: The pages that were updated.
type: array
@@ -124045,7 +123377,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *723
+ repository: *718
sender: *4
required:
- pages
@@ -124121,10 +123453,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: &741
+ organization: *717
+ repositories: &736
description: An array of repository objects that the installation
can access.
type: array
@@ -124150,8 +123482,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *723
- requester: *740
+ repository: *718
+ requester: *735
sender: *4
required:
- action
@@ -124226,11 +123558,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: *741
- repository: *723
+ organization: *717
+ repositories: *736
+ repository: *718
requester:
nullable: true
sender: *4
@@ -124306,11 +123638,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: *741
- repository: *723
+ organization: *717
+ repositories: *736
+ repository: *718
requester:
nullable: true
sender: *4
@@ -124386,10 +123718,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories_added: &742
+ organization: *717
+ repositories_added: &737
description: An array of repository objects, which were added to
the installation.
type: array
@@ -124435,15 +123767,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *723
- repository_selection: &743
+ repository: *718
+ repository_selection: &738
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *740
+ requester: *735
sender: *4
required:
- action
@@ -124522,10 +123854,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories_added: *742
+ organization: *717
+ repositories_added: *737
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -124552,9 +123884,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *723
- repository_selection: *743
- requester: *740
+ repository: *718
+ repository_selection: *738
+ requester: *735
sender: *4
required:
- action
@@ -124633,11 +123965,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: *741
- repository: *723
+ organization: *717
+ repositories: *736
+ repository: *718
requester:
nullable: true
sender: *4
@@ -124815,10 +124147,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
target_type:
type: string
@@ -124897,11 +124229,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *720
+ enterprise: *715
installation: *22
- organization: *722
- repositories: *741
- repository: *723
+ organization: *717
+ repositories: *736
+ repository: *718
requester:
nullable: true
sender: *4
@@ -125153,8 +124485,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -125948,8 +125280,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -126298,8 +125630,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -126379,7 +125711,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &744
+ comment: &739
title: issue comment
description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment)
itself.
@@ -126544,8 +125876,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -127335,8 +126667,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -127687,8 +127019,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -127768,7 +127100,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &773
+ changes: &768
description: The changes to the comment.
type: object
properties:
@@ -127780,9 +127112,9 @@ x-webhooks:
type: string
required:
- from
- comment: *744
- enterprise: *720
- installation: *721
+ comment: *739
+ enterprise: *715
+ installation: *716
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -128575,8 +127907,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -128925,8 +128257,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129016,9 +128348,9 @@ x-webhooks:
type: number
blocking_issue: *75
blocking_issue_repo: *71
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129107,9 +128439,9 @@ x-webhooks:
type: number
blocking_issue: *75
blocking_issue_repo: *71
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129197,9 +128529,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129288,9 +128620,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -129370,10 +128702,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *740
- enterprise: *720
- installation: *721
- issue: &747
+ assignee: *735
+ enterprise: *715
+ installation: *716
+ issue: &742
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -130162,11 +129494,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -130283,8 +129615,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -130364,8 +129696,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -131159,11 +130491,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -131415,8 +130747,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -131495,8 +130827,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -132281,11 +131613,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -132401,8 +131733,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -132481,8 +131813,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -133289,11 +132621,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -133388,7 +132720,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &745
+ milestone: &740
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -133526,8 +132858,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -133626,8 +132958,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -134416,11 +133748,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -134537,9 +133869,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *739
- organization: *722
- repository: *723
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -134619,8 +133951,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -135408,11 +134740,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -135529,9 +134861,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *739
- organization: *722
- repository: *723
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -135611,8 +134943,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -136424,11 +135756,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -136522,8 +135854,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -136602,8 +135934,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -137409,11 +136741,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -137507,9 +136839,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *745
- organization: *722
- repository: *723
+ milestone: *740
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -138377,11 +137709,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -138943,8 +138275,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -139733,11 +139065,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -139853,8 +139185,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -139934,9 +139266,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *720
- installation: *721
- issue: &746
+ enterprise: *715
+ installation: *716
+ issue: &741
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
itself.
@@ -140719,11 +140051,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -140839,8 +140171,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -140919,8 +140251,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -141730,11 +141062,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -141829,8 +141161,8 @@ x-webhooks:
user_view_type:
type: string
type: *227
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -142696,11 +142028,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143284,11 +142616,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *720
- installation: *721
- issue: *746
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ issue: *741
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -143368,12 +142700,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *720
- installation: *721
- issue: *747
+ enterprise: *715
+ installation: *716
+ issue: *742
type: *227
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -143454,7 +142786,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &776
+ assignee: &771
title: User
type: object
nullable: true
@@ -143524,11 +142856,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *720
- installation: *721
- issue: *747
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ issue: *742
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -143607,12 +142939,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *720
- installation: *721
- issue: *747
- label: *739
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ issue: *742
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -143692,8 +143024,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
issue:
title: Issue
description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue)
@@ -144503,11 +143835,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *654
- issue_dependencies_summary: *655
+ sub_issues_summary: *651
+ issue_dependencies_summary: *652
issue_field_values:
type: array
- items: *656
+ items: *653
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -144601,8 +143933,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -144682,11 +144014,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *720
- installation: *721
- issue: *746
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ issue: *741
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -144765,12 +144097,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *720
- installation: *721
- issue: *747
+ enterprise: *715
+ installation: *716
+ issue: *742
type: *227
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -144850,11 +144182,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- label: *739
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -144932,11 +144264,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- label: *739
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -145046,11 +144378,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- label: *739
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ label: *734
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -145132,9 +144464,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *720
- installation: *721
- marketplace_purchase: &748
+ enterprise: *715
+ installation: *716
+ marketplace_purchase: &743
title: Marketplace Purchase
type: object
required:
@@ -145217,8 +144549,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *722
- previous_marketplace_purchase: &749
+ organization: *717
+ previous_marketplace_purchase: &744
title: Marketplace Purchase
type: object
properties:
@@ -145298,7 +144630,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -145378,10 +144710,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *720
- installation: *721
- marketplace_purchase: *748
- organization: *722
+ enterprise: *715
+ installation: *716
+ marketplace_purchase: *743
+ organization: *717
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -145464,7 +144796,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -145546,10 +144878,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *720
- installation: *721
- marketplace_purchase: *748
- organization: *722
+ enterprise: *715
+ installation: *716
+ marketplace_purchase: *743
+ organization: *717
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -145631,7 +144963,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -145712,8 +145044,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -145795,9 +145127,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *722
- previous_marketplace_purchase: *749
- repository: *723
+ organization: *717
+ previous_marketplace_purchase: *744
+ repository: *718
sender: *4
required:
- action
@@ -145877,12 +145209,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *720
- installation: *721
- marketplace_purchase: *748
- organization: *722
- previous_marketplace_purchase: *749
- repository: *723
+ enterprise: *715
+ installation: *716
+ marketplace_purchase: *743
+ organization: *717
+ previous_marketplace_purchase: *744
+ repository: *718
sender: *4
required:
- action
@@ -145984,11 +145316,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146088,11 +145420,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146171,11 +145503,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146253,11 +145585,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -146333,7 +145665,7 @@ x-webhooks:
required:
- login
- id
- team: &750
+ team: &745
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -146556,11 +145888,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *720
- installation: *721
- member: *740
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ member: *735
+ organization: *717
+ repository: *718
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -146637,7 +145969,7 @@ x-webhooks:
required:
- login
- id
- team: *750
+ team: *745
required:
- action
- scope
@@ -146719,8 +146051,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *721
- merge_group: &752
+ installation: *716
+ merge_group: &747
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -146739,15 +146071,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *751
+ head_commit: *746
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146833,10 +146165,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *721
- merge_group: *752
- organization: *722
- repository: *723
+ installation: *716
+ merge_group: *747
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -146909,7 +146241,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
+ enterprise: *715
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -147018,16 +146350,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *753
- required: *754
+ properties: *748
+ required: *749
nullable: true
sender: *4
required:
@@ -147108,11 +146440,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *720
- installation: *721
- milestone: *745
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ milestone: *740
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147191,9 +146523,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- milestone: &755
+ enterprise: *715
+ installation: *716
+ milestone: &750
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -147330,8 +146662,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147410,11 +146742,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- milestone: *745
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ milestone: *740
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147524,11 +146856,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- milestone: *745
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ milestone: *740
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147608,11 +146940,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *720
- installation: *721
- milestone: *755
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ milestone: *750
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147691,11 +147023,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *740
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ blocked_user: *735
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147774,11 +147106,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *740
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ blocked_user: *735
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -147857,9 +147189,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- membership: &756
+ enterprise: *715
+ installation: *716
+ membership: &751
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -147966,8 +147298,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -148045,11 +147377,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *720
- installation: *721
- membership: *756
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ membership: *751
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -148128,8 +147460,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -148245,10 +147577,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
- user: *740
+ user: *735
required:
- action
- invitation
@@ -148326,11 +147658,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *720
- installation: *721
- membership: *756
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ membership: *751
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -148417,11 +147749,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *720
- installation: *721
- membership: *756
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ membership: *751
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -148497,9 +147829,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
package:
description: Information about the package.
type: object
@@ -148998,7 +148330,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &757
+ items: &752
title: Ruby Gems metadata
type: object
properties:
@@ -149093,7 +148425,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -149169,9 +148501,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
package:
description: Information about the package.
type: object
@@ -149524,7 +148856,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *757
+ items: *752
source_url:
type: string
format: uri
@@ -149594,7 +148926,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -149771,12 +149103,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *720
+ enterprise: *715
id:
type: integer
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- id
@@ -149853,7 +149185,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &758
+ personal_access_token_request: &753
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -149999,10 +149331,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *720
- organization: *722
+ enterprise: *715
+ organization: *717
sender: *4
- installation: *721
+ installation: *716
required:
- action
- personal_access_token_request
@@ -150079,11 +149411,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *758
- enterprise: *720
- organization: *722
+ personal_access_token_request: *753
+ enterprise: *715
+ organization: *717
sender: *4
- installation: *721
+ installation: *716
required:
- action
- personal_access_token_request
@@ -150159,11 +149491,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *758
- enterprise: *720
- organization: *722
+ personal_access_token_request: *753
+ enterprise: *715
+ organization: *717
sender: *4
- installation: *721
+ installation: *716
required:
- action
- personal_access_token_request
@@ -150238,11 +149570,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *758
- organization: *722
- enterprise: *720
+ personal_access_token_request: *753
+ organization: *717
+ enterprise: *715
sender: *4
- installation: *721
+ installation: *716
required:
- action
- personal_access_token_request
@@ -150347,7 +149679,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *759
+ last_response: *754
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -150379,8 +149711,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
zen:
description: Random string of GitHub zen.
@@ -150625,10 +149957,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *720
- installation: *721
- organization: *722
- project_card: &760
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_card: &755
title: Project Card
type: object
properties:
@@ -150747,7 +150079,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -150828,11 +150160,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- project_card: *760
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_card: *755
+ repository: *718
sender: *4
required:
- action
@@ -150912,9 +150244,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
project_card:
title: Project Card
type: object
@@ -151042,8 +150374,8 @@ x-webhooks:
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *753
- required: *754
+ properties: *748
+ required: *749
nullable: true
sender: *4
required:
@@ -151137,11 +150469,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *720
- installation: *721
- organization: *722
- project_card: *760
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_card: *755
+ repository: *718
sender: *4
required:
- action
@@ -151235,9 +150567,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
project_card:
allOf:
- title: Project Card
@@ -151427,7 +150759,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -151507,10 +150839,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *720
- installation: *721
- organization: *722
- project: &762
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: &757
title: Project
type: object
properties:
@@ -151634,7 +150966,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -151714,10 +151046,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- project_column: &761
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_column: &756
title: Project Column
type: object
properties:
@@ -151756,7 +151088,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -151835,18 +151167,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- project_column: *761
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_column: *756
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *753
- required: *754
+ properties: *748
+ required: *749
nullable: true
sender: *4
required:
@@ -151936,11 +151268,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- project_column: *761
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_column: *756
+ repository: *718
sender: *4
required:
- action
@@ -152020,11 +151352,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *720
- installation: *721
- organization: *722
- project_column: *761
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project_column: *756
+ repository: *718
sender: *4
required:
- action
@@ -152104,11 +151436,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- project: *762
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: *757
+ repository: *718
sender: *4
required:
- action
@@ -152188,18 +151520,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- project: *762
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: *757
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *753
- required: *754
+ properties: *748
+ required: *749
nullable: true
sender: *4
required:
@@ -152301,11 +151633,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- project: *762
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: *757
+ repository: *718
sender: *4
required:
- action
@@ -152384,11 +151716,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *720
- installation: *721
- organization: *722
- project: *762
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ project: *757
+ repository: *718
sender: *4
required:
- action
@@ -152469,8 +151801,8 @@ x-webhooks:
type: string
enum:
- closed
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -152552,8 +151884,8 @@ x-webhooks:
type: string
enum:
- created
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -152635,8 +151967,8 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -152754,8 +152086,8 @@ x-webhooks:
type: string
to:
type: string
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -152839,7 +152171,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &766
+ changes: &761
type: object
properties:
archived_at:
@@ -152853,9 +152185,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *721
- organization: *722
- projects_v2_item: &763
+ installation: *716
+ organization: *717
+ projects_v2_item: &758
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -152990,9 +152322,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153074,9 +152406,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153157,9 +152489,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153265,7 +152597,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &764
+ - &759
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -153287,7 +152619,7 @@ x-webhooks:
required:
- id
- name
- - &765
+ - &760
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -153321,8 +152653,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *764
- - *765
+ - *759
+ - *760
required:
- field_value
- type: object
@@ -153338,9 +152670,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153435,9 +152767,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *721
- organization: *722
- projects_v2_item: *763
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153520,10 +152852,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *766
- installation: *721
- organization: *722
- projects_v2_item: *763
+ changes: *761
+ installation: *716
+ organization: *717
+ projects_v2_item: *758
sender: *4
required:
- action
@@ -153605,8 +152937,8 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
projects_v2: *261
sender: *4
required:
@@ -153688,14 +153020,14 @@ x-webhooks:
type: string
enum:
- created
- installation: *721
- organization: *722
- projects_v2_status_update: &769
+ installation: *716
+ organization: *717
+ projects_v2_status_update: &764
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: *767
- required: *768
+ properties: *762
+ required: *763
sender: *4
required:
- action
@@ -153776,9 +153108,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *721
- organization: *722
- projects_v2_status_update: *769
+ installation: *716
+ organization: *717
+ projects_v2_status_update: *764
sender: *4
required:
- action
@@ -153914,9 +153246,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *721
- organization: *722
- projects_v2_status_update: *769
+ installation: *716
+ organization: *717
+ projects_v2_status_update: *764
sender: *4
required:
- action
@@ -153987,10 +153319,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- repository
@@ -154067,13 +153399,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *740
- enterprise: *720
- installation: *721
- number: &770
+ assignee: *735
+ enterprise: *715
+ installation: *716
+ number: &765
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -156356,7 +155688,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -156438,11 +155770,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -158720,7 +158052,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -158802,11 +158134,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -161084,7 +160416,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -161166,13 +160498,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: &771
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: &766
allOf:
- - *576
+ - *573
- type: object
properties:
allow_auto_merge:
@@ -161234,7 +160566,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -161315,12 +160647,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -161400,11 +160732,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *720
- milestone: *558
- number: *770
- organization: *722
- pull_request: &772
+ enterprise: *715
+ milestone: *555
+ number: *765
+ organization: *717
+ pull_request: &767
title: Pull Request
type: object
properties:
@@ -163667,7 +162999,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -163746,11 +163078,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -166032,7 +165364,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -166156,12 +165488,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -166241,11 +165573,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -168512,7 +167844,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -168592,11 +167924,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *720
- installation: *721
- label: *739
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ label: *734
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -170878,7 +170210,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -170959,10 +170291,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -173242,7 +172574,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -173322,12 +172654,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *720
- milestone: *558
- number: *770
- organization: *722
- pull_request: *772
- repository: *723
+ enterprise: *715
+ milestone: *555
+ number: *765
+ organization: *717
+ pull_request: *767
+ repository: *718
sender: *4
required:
- action
@@ -173406,12 +172738,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -173492,12 +172824,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -173577,12 +172909,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
- pull_request: *771
- repository: *723
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
+ pull_request: *766
+ repository: *718
sender: *4
required:
- action
@@ -173948,9 +173280,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
type: object
properties:
@@ -176120,7 +175452,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -176200,7 +175532,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &774
+ comment: &769
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -176485,9 +175817,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
type: object
properties:
@@ -178645,7 +177977,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -178725,11 +178057,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *773
- comment: *774
- enterprise: *720
- installation: *721
- organization: *722
+ changes: *768
+ comment: *769
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
type: object
properties:
@@ -180890,7 +180222,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -180971,9 +180303,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -183146,7 +182478,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
+ repository: *718
review:
description: The review that was affected.
type: object
@@ -183393,9 +182725,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -185449,8 +184781,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
- review: &775
+ repository: *718
+ review: &770
description: The review that was affected.
type: object
properties:
@@ -185683,12 +185015,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -187971,7 +187303,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
requested_reviewer:
title: User
type: object
@@ -188055,12 +187387,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -190350,7 +189682,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -190542,12 +189874,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -192832,7 +192164,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
requested_reviewer:
title: User
type: object
@@ -192917,12 +192249,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *720
- installation: *721
+ enterprise: *715
+ installation: *716
number:
description: The pull request number.
type: integer
- organization: *722
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -195198,7 +194530,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -195379,9 +194711,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -197556,8 +196888,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
- review: *775
+ repository: *718
+ review: *770
sender: *4
required:
- action
@@ -197637,9 +196969,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -199709,7 +199041,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
thread:
type: object
@@ -200096,9 +199428,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
pull_request:
title: Simple Pull Request
type: object
@@ -202154,7 +201486,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *723
+ repository: *718
sender: *4
thread:
type: object
@@ -202544,10 +201876,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -204818,7 +204150,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -204900,11 +204232,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *776
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
+ assignee: *771
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -207187,7 +206519,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -207266,11 +206598,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *720
- installation: *721
- label: *739
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ label: *734
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -209543,7 +208875,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -209624,10 +208956,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *720
- installation: *721
- number: *770
- organization: *722
+ enterprise: *715
+ installation: *716
+ number: *765
+ organization: *717
pull_request:
title: Pull Request
type: object
@@ -211892,7 +211224,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -212092,7 +211424,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *720
+ enterprise: *715
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -212184,8 +211516,8 @@ x-webhooks:
- url
- author
- committer
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -212760,9 +212092,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
registry_package:
type: object
properties:
@@ -213208,7 +212540,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *757
+ items: *752
summary:
type: string
tag_name:
@@ -213262,7 +212594,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -213340,9 +212672,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
registry_package:
type: object
properties:
@@ -213650,7 +212982,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *757
+ items: *752
summary:
type: string
tag_name:
@@ -213699,7 +213031,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -213776,10 +213108,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- release: &777
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: &772
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -214097,7 +213429,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -214174,11 +213506,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- release: *777
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: *772
+ repository: *718
sender: *4
required:
- action
@@ -214295,11 +213627,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *720
- installation: *721
- organization: *722
- release: *777
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: *772
+ repository: *718
sender: *4
required:
- action
@@ -214377,9 +213709,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -214701,7 +214033,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -214777,10 +214109,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
- release: &778
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: &773
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
object.
@@ -215099,7 +214431,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *723
+ repository: *718
sender: *4
required:
- action
@@ -215175,11 +214507,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *720
- installation: *721
- organization: *722
- release: *777
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: *772
+ repository: *718
sender: *4
required:
- action
@@ -215255,11 +214587,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *720
- installation: *721
- organization: *722
- release: *778
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ release: *773
+ repository: *718
sender: *4
required:
- action
@@ -215335,11 +214667,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- repository_advisory: *640
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ repository_advisory: *637
sender: *4
required:
- action
@@ -215415,11 +214747,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- repository_advisory: *640
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ repository_advisory: *637
sender: *4
required:
- action
@@ -215495,10 +214827,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215575,10 +214907,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215656,10 +214988,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215743,10 +215075,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215858,10 +215190,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -215933,10 +215265,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
status:
type: string
@@ -216017,10 +215349,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216097,10 +215429,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216194,10 +215526,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216277,10 +215609,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
repository_ruleset: *307
sender: *4
required:
@@ -216359,10 +215691,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
repository_ruleset: *307
sender: *4
required:
@@ -216441,10 +215773,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
repository_ruleset: *307
changes:
type: object
@@ -216506,16 +215838,16 @@ x-webhooks:
properties:
added:
type: array
- items: *596
+ items: *593
deleted:
type: array
- items: *596
+ items: *593
updated:
type: array
items:
type: object
properties:
- rule: *596
+ rule: *593
changes:
type: object
properties:
@@ -216749,10 +216081,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216830,10 +216162,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -216911,7 +216243,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &779
+ alert: &774
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -217032,10 +216364,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217241,10 +216573,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217322,11 +216654,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *779
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *774
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217525,10 +216857,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217606,7 +216938,7 @@ x-webhooks:
type: string
enum:
- assigned
- alert: &780
+ alert: &775
type: object
properties:
number: *170
@@ -217725,10 +217057,10 @@ x-webhooks:
required: *21
nullable: true
assignee: *4
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217806,11 +217138,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -217891,11 +217223,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *780
- installation: *721
- location: *781
- organization: *722
- repository: *723
+ alert: *775
+ installation: *716
+ location: *776
+ organization: *717
+ repository: *718
sender: *4
required:
- location
@@ -218133,11 +217465,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218215,11 +217547,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218297,11 +217629,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218379,12 +217711,12 @@ x-webhooks:
type: string
enum:
- unassigned
- alert: *780
+ alert: *775
assignee: *4
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218462,11 +217794,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *780
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ alert: *775
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -218592,10 +217924,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *723
- enterprise: *720
- installation: *721
- organization: *722
+ repository: *718
+ enterprise: *715
+ installation: *716
+ organization: *717
sender: *4
required:
- action
@@ -218673,11 +218005,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- security_advisory: &782
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ security_advisory: &777
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -218860,11 +218192,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
- security_advisory: *782
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
+ security_advisory: *777
sender: *4
required:
- action
@@ -218937,10 +218269,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -219125,10 +218457,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *280
- enterprise: *720
- installation: *721
- organization: *722
- repository: *330
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *327
sender: *4
required:
- changes
@@ -219206,12 +218538,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: &783
+ sponsorship: &778
type: object
properties:
created_at:
@@ -219512,12 +218844,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- sponsorship
@@ -219605,12 +218937,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- changes
@@ -219687,17 +219019,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &784
+ effective_date: &779
description: The `pending_cancellation` and `pending_tier_change`
event types will include the date the cancellation or tier change
will take effect.
type: string
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- sponsorship
@@ -219771,7 +219103,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &785
+ changes: &780
type: object
properties:
tier:
@@ -219815,13 +219147,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *784
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ effective_date: *779
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- changes
@@ -219898,13 +219230,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *785
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ changes: *780
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- sponsorship: *783
+ sponsorship: *778
required:
- action
- changes
@@ -219978,10 +219310,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -220064,10 +219396,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -220487,15 +219819,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *720
+ enterprise: *715
id:
description: The unique identifier of the status.
type: integer
- installation: *721
+ installation: *716
name:
type: string
- organization: *722
- repository: *723
+ organization: *717
+ repository: *718
sender: *4
sha:
description: The Commit SHA.
@@ -220610,9 +219942,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -220702,9 +220034,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -220794,9 +220126,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -220886,9 +220218,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *75
- installation: *721
- organization: *722
- repository: *723
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -220965,12 +220297,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- team: &786
+ team: &781
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -221193,9 +220525,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -221653,7 +220985,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- team
@@ -221729,9 +221061,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -222189,7 +221521,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- team
@@ -222266,9 +221598,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -222726,7 +222058,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- team
@@ -222870,9 +222202,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -223330,7 +222662,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- changes
@@ -223408,9 +222740,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *720
- installation: *721
- organization: *722
+ enterprise: *715
+ installation: *716
+ organization: *717
repository:
title: Repository
description: A git repository
@@ -223868,7 +223200,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *786
+ team: *781
required:
- action
- team
@@ -223944,10 +223276,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
required:
- action
@@ -224020,16 +223352,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *720
+ enterprise: *715
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *721
- organization: *722
+ installation: *716
+ organization: *717
ref:
type: string
- repository: *723
+ repository: *718
sender: *4
workflow:
type: string
@@ -224111,10 +223443,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
workflow_job:
allOf:
@@ -224351,7 +223683,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *488
+ deployment: *485
required:
- action
- repository
@@ -224430,10 +223762,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
workflow_job:
allOf:
@@ -224693,7 +224025,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *488
+ deployment: *485
required:
- action
- repository
@@ -224772,10 +224104,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
workflow_job:
type: object
@@ -224910,7 +224242,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *488
+ deployment: *485
required:
- action
- repository
@@ -224989,10 +224321,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
workflow_job:
type: object
@@ -225128,7 +224460,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *488
+ deployment: *485
required:
- action
- repository
@@ -225208,12 +224540,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: *735
+ workflow: *730
workflow_run:
title: Workflow Run
type: object
@@ -226212,12 +225544,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: *735
+ workflow: *730
workflow_run:
title: Workflow Run
type: object
@@ -227201,12 +226533,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *720
- installation: *721
- organization: *722
- repository: *723
+ enterprise: *715
+ installation: *716
+ organization: *717
+ repository: *718
sender: *4
- workflow: *735
+ workflow: *730
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json
index 941f70958..b102e60d4 100644
--- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json
+++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json
@@ -250817,17 +250817,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
+ "/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List a connection between an external group and a team",
+ "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussions-in-org",
+ "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
},
"parameters": [
{
@@ -250847,19 +250847,380 @@
"schema": {
"type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroups",
+ "description": "A list of external groups available to be connected to a team",
+ "type": "object",
+ "properties": {
+ "groups": {
+ "description": "An array of external groups available to be mapped to a team",
+ "example": [
+ {
+ "group_id": 1,
+ "group_name": "group-azuread-test",
+ "updated_at": "2021-01-03 22:27:15:000 -700"
+ },
+ {
+ "group_id": 2,
+ "group_name": "group-azuread-test2",
+ "updated_at": "2021-06-03 22:27:15:000 -700"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00"
+ },
+ {
+ "group_id": "456",
+ "group_name": "Octocat docs members",
+ "updated_at": "2021-03-24T11:31:04-06:00"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "patch": {
+ "summary": "Update the connection between an external group and a team",
+ "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
},
{
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "group_id": {
+ "type": "integer",
+ "description": "External Group Id",
+ "example": 1
+ }
+ },
+ "required": [
+ "group_id"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroup",
+ "description": "Information about an external group's usage and its members",
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "teams",
+ "members"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name for the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The date when the group was last updated_at",
+ "example": "2021-01-03 22:27:15:000 -700",
+ "type": "string"
+ },
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "example": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "example": 1,
+ "type": "integer"
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "example": "team-test",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "example": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "member_id",
+ "member_login",
+ "member_name",
+ "member_email"
+ ],
+ "properties": {
+ "member_id": {
+ "description": "The internal user ID of the identity",
+ "example": 1,
+ "type": "integer"
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "example": "mona-lisa_eocsaxrs",
+ "type": "string"
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "example": "Mona Lisa",
+ "type": "string"
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "example": "mona_lisa@github.com",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00",
+ "teams": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "members": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "delete": {
+ "summary": "Remove the connection between an external group and a team",
+ "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/unlink-external-idp-group-from-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/invitations": {
+ "get": {
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-pending-invitations-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
},
{
@@ -250879,15 +251240,6 @@
"type": "integer",
"default": 1
}
- },
- {
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
- "schema": {
- "type": "string"
- }
}
],
"responses": {
@@ -250898,11 +251250,37 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -251024,142 +251402,289 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
+ ]
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
+ "team_count": {
+ "type": "integer"
},
- "body_html": {
+ "node_id": {
"type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ },
+ "invitation_teams_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ },
+ "invitation_source": {
+ "type": "string",
+ "example": "\"member\""
+ }
+ },
+ "required": [
+ "id",
+ "login",
+ "email",
+ "role",
+ "created_at",
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-members-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "member",
+ "maintainer",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "email": {
+ "nullable": true,
"type": "string"
},
- "created_at": {
+ "login": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
},
- "last_edited_at": {
+ "node_id": {
"type": "string",
- "format": "date-time",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
+ "example": "https://github.com/octocat"
},
- "node_id": {
+ "followers_url": {
"type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
},
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
},
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
- "team_url": {
+ "subscriptions_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
+ "example": "https://api.github.com/users/octocat/subscriptions"
},
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
},
- "updated_at": {
+ "repos_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
},
- "url": {
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "https://api.github.com/users/octocat/received_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"
- ]
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
"html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
"url"
]
}
@@ -251168,52 +251693,24 @@
"default": {
"value": [
{
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
}
]
}
@@ -251234,19 +251731,124 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
+ "get": {
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Membership",
+ "description": "Team Membership",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of the user's membership in the team.",
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "role",
+ "state",
+ "url"
+ ]
+ },
+ "examples": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
+ "value": {
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "if user has no team membership"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
}
},
- "post": {
- "summary": "Create a discussion",
- "description": "Creates 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\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-in-org",
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -251266,39 +251868,40 @@
"schema": {
"type": "string"
}
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
+ "role": {
"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
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
}
- },
- "required": [
- "title",
- "body"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Add or update team membership for an organization member",
"value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "role": "maintainer"
}
}
}
@@ -251306,1127 +251909,81 @@
}
},
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
"url": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "format": "uri"
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/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"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
"value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "member",
+ "state": "pending"
}
}
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
},
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "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
- }
- }
- }
- }
- }
- }
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
}
},
"delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Remove 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/delete-discussion-in-org",
+ "operationId": "teams/remove-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -252448,39 +252005,42 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/external-groups": {
+ "/orgs/{org}/teams/{team_slug}/repos": {
"get": {
- "summary": "List a connection between an external group and a team",
- "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "summary": "List team repositories",
+ "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
"tags": [
"teams"
],
- "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
+ "operationId": "teams/list-repos-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-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/teams#list-team-repositories"
},
"parameters": [
{
@@ -252500,398 +252060,23 @@
"schema": {
"type": "string"
}
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroups",
- "description": "A list of external groups available to be connected to a team",
- "type": "object",
- "properties": {
- "groups": {
- "description": "An array of external groups available to be mapped to a team",
- "example": [
- {
- "group_id": 1,
- "group_name": "group-azuread-test",
- "updated_at": "2021-01-03 22:27:15:000 -700"
- },
- {
- "group_id": 2,
- "group_name": "group-azuread-test2",
- "updated_at": "2021-06-03 22:27:15:000 -700"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name of the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The time of the last update for this group",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00"
- },
- {
- "group_id": "456",
- "group_name": "Octocat docs members",
- "updated_at": "2021-03-24T11:31:04-06:00"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "patch": {
- "summary": "Update the connection between an external group and a team",
- "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/link-external-idp-group-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
+ },
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
+ "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": "string"
+ "type": "integer",
+ "default": 30
}
},
{
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
"schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "group_id": {
- "type": "integer",
- "description": "External Group Id",
- "example": 1
- }
- },
- "required": [
- "group_id"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "group_id": 123
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroup",
- "description": "Information about an external group's usage and its members",
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "teams",
- "members"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name for the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "example": "2021-01-03 22:27:15:000 -700",
- "type": "string"
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "example": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "example": 1,
- "type": "integer"
- },
- "team_name": {
- "description": "The name of the team",
- "example": "team-test",
- "type": "string"
- }
- }
- }
- },
- "members": {
- "description": "An array of external members linked to this group",
- "example": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "member_id",
- "member_login",
- "member_name",
- "member_email"
- ],
- "properties": {
- "member_id": {
- "description": "The internal user ID of the identity",
- "example": 1,
- "type": "integer"
- },
- "member_login": {
- "description": "The handle/login for the user",
- "example": "mona-lisa_eocsaxrs",
- "type": "string"
- },
- "member_name": {
- "description": "The user display name/profile name",
- "example": "Mona Lisa",
- "type": "string"
- },
- "member_email": {
- "description": "An email attached to a user",
- "example": "mona_lisa@github.com",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00",
- "teams": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "members": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "delete": {
- "summary": "Remove the connection between an external group and a team",
- "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/unlink-external-idp-group-from-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/invitations": {
- "get": {
- "summary": "List pending team invitations",
- "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-pending-invitations-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
+ "type": "integer",
+ "default": 1
}
}
],
@@ -252903,37 +252088,28 @@
"schema": {
"type": "array",
"items": {
- "title": "Organization Invitation",
- "description": "Organization Invitation",
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
"type": "object",
"properties": {
"id": {
"type": "integer",
- "format": "int64"
- },
- "login": {
- "type": "string",
- "nullable": true
+ "format": "int64",
+ "example": 1296269
},
- "email": {
+ "node_id": {
"type": "string",
- "nullable": true
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
- "failed_at": {
+ "name": {
"type": "string",
- "nullable": true
+ "example": "Hello-World"
},
- "failed_reason": {
+ "full_name": {
"type": "string",
- "nullable": true
+ "example": "octocat/Hello-World"
},
- "inviter": {
+ "owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -253057,32 +252233,550 @@
"url"
]
},
- "team_count": {
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
"type": "integer"
},
- "node_id": {
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "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",
- "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
},
- "invitation_teams_url": {
+ "created_at": {
"type": "string",
- "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
},
- "invitation_source": {
+ "updated_at": {
"type": "string",
- "example": "\"member\""
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "code_of_conduct": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "contributor_covenant"
+ },
+ "name": {
+ "type": "string",
+ "example": "Contributor Covenant"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ },
+ "body": {
+ "type": "string",
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ },
+ "license": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "nullable": true
+ },
+ "forks": {
+ "type": "integer",
+ "example": 0
+ },
+ "open_issues": {
+ "type": "integer",
+ "example": 0
+ },
+ "watchers": {
+ "type": "integer",
+ "example": 0
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "security_and_analysis": {
+ "nullable": true,
+ "type": "object",
+ "properties": {
+ "advanced_security": {
+ "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n",
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "code_security": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "dependabot_security_updates": {
+ "description": "Enable or disable Dependabot security updates for the repository.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The enablement status of Dependabot security updates for the repository.",
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_push_protection": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_non_provider_patterns": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_ai_detection": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "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",
- "login",
- "email",
- "role",
- "created_at",
- "inviter",
- "team_count",
- "invitation_teams_url",
- "node_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"
]
}
},
@@ -253090,37 +252784,122 @@
"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": 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/other_user_happy.gif",
+ "avatar_url": "https://github.com/images/error/octocat_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",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/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"
+ "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"
+ }
+ }
}
]
}
@@ -253141,21 +252920,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "members"
+ "subcategory": "teams"
}
}
},
- "/orgs/{org}/teams/{team_slug}/members": {
+ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
"get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "summary": "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/list-members-in-org",
+ "operationId": "teams/check-permissions-for-repo-in-org",
"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/teams/teams#check-team-permissions-for-a-repository"
},
"parameters": [
{
@@ -253177,175 +252956,705 @@
}
},
{
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "default": 30
+ "type": "string"
}
},
{
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "default": 1
+ "type": "string"
}
}
],
"responses": {
"200": {
- "description": "Response",
+ "description": "Alternative response with repository permissions",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
+ "title": "Team Repository",
+ "description": "A team's access to a repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "license": {
+ "title": "License Simple",
+ "description": "License Simple",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit"
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
},
- "site_admin": {
- "type": "boolean"
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ],
+ "nullable": true
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ],
+ "nullable": true
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
}
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ]
},
"examples": {
- "default": {
- "value": [
- {
+ "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=",
@@ -253364,41 +253673,136 @@
"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
+ }
}
}
}
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
}
+ },
+ "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": "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/enterprise-cloud@latest//rest/teams/teams#create-a-team).",
+ },
+ "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/get-membership-for-user-in-org",
+ "operationId": "teams/add-or-update-repo-permissions-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions"
},
"parameters": [
{
@@ -253420,8 +253824,17 @@
}
},
{
- "name": "username",
- "description": "The handle for the GitHub user account.",
+ "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": {
@@ -253429,79 +253842,52 @@
}
}
],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
+ "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"
}
}
}
}
- },
- "404": {
- "description": "if user has no team membership"
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "members"
+ "subcategory": "teams"
}
},
- "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}`.",
+ "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/add-or-update-membership-for-user-in-org",
+ "operationId": "teams/remove-repo-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team"
},
"parameters": [
{
@@ -253523,8 +253909,17 @@
}
},
{
- "name": "username",
- "description": "The handle for the GitHub user account.",
+ "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": {
@@ -253532,111 +253927,154 @@
}
}
],
- "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": {
+ "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": "Team Membership",
- "description": "Team Membership",
+ "title": "GroupMapping",
+ "description": "External Groups to be mapped to a team for membership",
"type": "object",
"properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
+ "groups": {
+ "description": "Array of groups to be mapped to this team",
+ "example": [
+ {
+ "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"
+ }
],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "group_description"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The ID of the group",
+ "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
+ "type": "string"
+ },
+ "group_name": {
+ "description": "The name of the group",
+ "example": "saml-azuread-test",
+ "type": "string"
+ },
+ "group_description": {
+ "description": "a description of the group",
+ "example": "A group of Developers working on AzureAD SAML SSO",
+ "type": "string"
+ },
+ "status": {
+ "description": "synchronization status for this group mapping",
+ "example": "unsynced",
+ "type": "string"
+ },
+ "synced_at": {
+ "description": "the time of the last sync for this group-mapping",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
}
- },
- "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",
+ "default": {
"value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "member",
- "state": "pending"
+ "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."
+ }
+ ]
}
}
}
}
}
- },
- "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,
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
"category": "teams",
- "subcategory": "members"
+ "subcategory": "team-sync"
}
},
- "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}`.",
+ "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/remove-membership-for-user-in-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/members#remove-team-membership-for-a-user"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections"
},
"parameters": [
{
@@ -253656,44 +254094,165 @@
"schema": {
"type": "string"
}
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "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": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
+ "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",
+ "example": [
+ {
+ "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"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "group_description"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The ID of the group",
+ "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
+ "type": "string"
+ },
+ "group_name": {
+ "description": "The name of the group",
+ "example": "saml-azuread-test",
+ "type": "string"
+ },
+ "group_description": {
+ "description": "a description of the group",
+ "example": "A group of Developers working on AzureAD SAML SSO",
+ "type": "string"
+ },
+ "status": {
+ "description": "synchronization status for this group mapping",
+ "example": "unsynced",
+ "type": "string"
+ },
+ "synced_at": {
+ "description": "the time of the last sync for this group-mapping",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": false,
- "enabledForGitHubApps": true,
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
"category": "teams",
- "subcategory": "members"
+ "subcategory": "team-sync"
}
}
},
- "/orgs/{org}/teams/{team_slug}/repos": {
+ "/orgs/{org}/teams/{team_slug}/teams": {
"get": {
- "summary": "List team repositories",
- "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
+ "summary": "List child teams",
+ "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.",
"tags": [
"teams"
],
- "operationId": "teams/list-repos-in-org",
+ "operationId": "teams/list-child-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams"
},
"parameters": [
{
@@ -253735,824 +254294,252 @@
],
"responses": {
"200": {
- "description": "Response",
+ "description": "if child teams exist",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "title": "Minimal Repository",
- "description": "Minimal Repository",
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
- "type": "integer",
- "format": "int64",
- "example": 1296269
+ "type": "integer"
},
"node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "type": "string",
- "example": "Hello-World"
- },
- "full_name": {
- "type": "string",
- "example": "octocat/Hello-World"
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
- },
- "description": {
- "type": "string",
- "example": "This your first repo!",
- "nullable": true
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- },
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- },
- "git_url": {
"type": "string"
},
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- },
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- },
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- },
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
+ "name": {
"type": "string"
},
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
- },
- "trees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
- },
- "clone_url": {
+ "slug": {
"type": "string"
},
- "mirror_url": {
+ "description": {
"type": "string",
"nullable": true
},
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
- },
- "svn_url": {
+ "privacy": {
"type": "string"
},
- "homepage": {
- "type": "string",
- "nullable": true
- },
- "language": {
- "type": "string",
- "nullable": true
- },
- "forks_count": {
- "type": "integer"
- },
- "stargazers_count": {
- "type": "integer"
- },
- "watchers_count": {
- "type": "integer"
- },
- "size": {
- "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
- "type": "integer"
- },
- "default_branch": {
+ "notification_setting": {
"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": {
+ "permission": {
"type": "string"
},
- "pushed_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:06:43Z",
- "nullable": true
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:01:12Z",
- "nullable": true
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:14:43Z",
- "nullable": true
- },
"permissions": {
"type": "object",
"properties": {
- "admin": {
+ "pull": {
"type": "boolean"
},
- "maintain": {
+ "triage": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
- "triage": {
+ "maintain": {
"type": "boolean"
},
- "pull": {
+ "admin": {
"type": "boolean"
}
- }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
},
- "role_name": {
+ "url": {
"type": "string",
- "example": "admin"
+ "format": "uri"
},
- "temp_clone_token": {
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
"type": "string"
},
- "delete_branch_on_merge": {
- "type": "boolean"
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
},
- "subscribers_count": {
- "type": "integer"
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "network_count": {
- "type": "integer"
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "code_of_conduct": {
- "title": "Code Of Conduct",
- "description": "Code Of Conduct",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "key": {
- "type": "string",
- "example": "contributor_covenant"
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
},
- "name": {
+ "node_id": {
"type": "string",
- "example": "Contributor Covenant"
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "body": {
+ "members_url": {
"type": "string",
- "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "html_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "nullable": true
- }
- },
- "required": [
- "url",
- "html_url",
- "key",
- "name"
- ]
- },
- "license": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
+ "example": "Justice League"
},
- "name": {
- "type": "string"
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
},
- "spdx_id": {
- "type": "string"
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
},
- "url": {
- "type": "string"
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
},
- "node_id": {
- "type": "string"
- }
- },
- "nullable": true
- },
- "forks": {
- "type": "integer",
- "example": 0
- },
- "open_issues": {
- "type": "integer",
- "example": 0
- },
- "watchers": {
- "type": "integer",
- "example": 0
- },
- "allow_forking": {
- "type": "boolean"
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "security_and_analysis": {
- "nullable": true,
- "type": "object",
- "properties": {
- "advanced_security": {
- "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n",
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
},
- "code_security": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "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"
- ]
- }
- }
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "secret_scanning": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
},
- "secret_scanning_push_protection": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
- "secret_scanning_non_provider_patterns": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "secret_scanning_ai_detection": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "secret_scanning_validity_checks": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
- }
- },
- "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": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
+ ],
+ "nullable": 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",
+ "url",
+ "members_url",
"name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url"
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent",
+ "type"
]
}
},
"examples": {
- "default": {
+ "response-if-child-teams-exist": {
"value": [
{
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
- "login": "octocat",
+ "id": 2,
+ "node_id": "MDQ6VGVhbTI=",
+ "url": "https://api.github.com/teams/2",
+ "name": "Original Roster",
+ "slug": "original-roster",
+ "description": "Started it all.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/2/members{/member}",
+ "repositories_url": "https://api.github.com/teams/2/repos",
+ "parent": {
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "private": false,
- "html_url": "https://github.com/octocat/Hello-World",
- "description": "This your first repo!",
- "fork": false,
- "url": "https://api.github.com/repos/octocat/Hello-World",
- "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
- "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
- "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
- "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
- "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
- "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
- "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
- "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
- "git_url": "git:github.com/octocat/Hello-World.git",
- "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
- "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
- "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
- "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
- "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
- "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
- "ssh_url": "git@github.com:octocat/Hello-World.git",
- "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
- "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
- "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
- "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
- "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
- "clone_url": "https://github.com/octocat/Hello-World.git",
- "mirror_url": "git:git.example.com/octocat/Hello-World",
- "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
- "svn_url": "https://svn.github.com/octocat/Hello-World",
- "homepage": "https://github.com",
- "language": null,
- "forks_count": 9,
- "stargazers_count": 80,
- "watchers_count": 80,
- "size": 108,
- "default_branch": "master",
- "open_issues_count": 0,
- "is_template": false,
- "topics": [
- "octocat",
- "atom",
- "electron",
- "api"
- ],
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true,
- "has_pages": false,
- "has_downloads": true,
- "has_discussions": false,
- "archived": false,
- "disabled": false,
- "visibility": "public",
- "pushed_at": "2011-01-26T19:06:43Z",
- "created_at": "2011-01-26T19:01:12Z",
- "updated_at": "2011-01-26T19:14:43Z",
- "permissions": {
- "admin": false,
- "push": false,
- "pull": true
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos"
},
- "security_and_analysis": {
- "advanced_security": {
- "status": "enabled"
- },
- "secret_scanning": {
- "status": "enabled"
- },
- "secret_scanning_push_protection": {
- "status": "disabled"
- },
- "secret_scanning_validity_checks": {
- "status": "disabled"
- }
- }
+ "html_url": "https://github.com/orgs/rails/teams/core"
}
]
}
@@ -254577,17 +254564,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
- "get": {
- "summary": "Check team permissions for a repository",
- "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-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}`.",
+ "/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/check-permissions-for-repo-in-org",
+ "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization"
},
"parameters": [
{
@@ -254600,14 +254587,586 @@
}
},
{
- "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": "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.",
@@ -254629,106 +255188,31 @@
],
"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",
- "example": 42,
- "type": "integer"
+ "type": "integer",
+ "format": "int64",
+ "example": 1296269
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"name": {
- "description": "The name of the repository.",
"type": "string",
- "example": "Team Environment"
+ "example": "Hello-World"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
- "license": {
- "title": "License Simple",
- "description": "License Simple",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "example": "mit"
- },
- "name": {
- "type": "string",
- "example": "MIT License"
- },
- "url": {
- "type": "string",
- "nullable": true,
- "format": "uri",
- "example": "https://api.github.com/licenses/mit"
- },
- "spdx_id": {
- "type": "string",
- "nullable": true,
- "example": "MIT"
- },
- "node_id": {
- "type": "string",
- "example": "MDc6TGljZW5zZW1pdA=="
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "key",
- "name",
- "url",
- "spdx_id",
- "node_id"
- ],
- "nullable": true
- },
- "forks": {
- "type": "integer"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- }
- },
- "required": [
- "admin",
- "pull",
- "push"
- ]
- },
- "role_name": {
- "type": "string",
- "example": "admin"
- },
"owner": {
"title": "Simple User",
"description": "A GitHub user.",
@@ -254851,12 +255335,9 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
+ ]
},
"private": {
- "description": "Whether the repository is private or public.",
- "default": false,
"type": "boolean"
},
"html_url": {
@@ -255080,11 +255561,11 @@
"example": 80
},
"size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
"type": "integer",
"example": 108
},
"default_branch": {
- "description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
@@ -255093,8 +255574,6 @@
"example": 0
},
"is_template": {
- "description": "Whether this repository acts as a template that can be used to generate new repositories.",
- "default": false,
"type": "boolean",
"example": true
},
@@ -255102,23 +255581,23 @@
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "example": [
+ "octocat",
+ "atom",
+ "electron",
+ "API"
+ ]
},
"has_issues": {
- "description": "Whether issues are enabled.",
- "default": true,
"type": "boolean",
"example": true
},
"has_projects": {
- "description": "Whether projects are enabled.",
- "default": true,
"type": "boolean",
"example": true
},
"has_wiki": {
- "description": "Whether the wiki is enabled.",
- "default": true,
"type": "boolean",
"example": true
},
@@ -255126,14 +255605,14 @@
"type": "boolean"
},
"has_downloads": {
- "description": "Whether downloads are enabled.",
- "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_discussions": {
"type": "boolean",
"example": true
},
"archived": {
- "description": "Whether the repository is archived.",
- "default": false,
"type": "boolean"
},
"disabled": {
@@ -255142,2182 +255621,50 @@
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
- "default": "public",
- "type": "string"
+ "type": "string",
+ "example": "public"
},
"pushed_at": {
"type": "string",
"format": "date-time",
- "example": "2011-01-26T19:06:43Z",
- "nullable": true
+ "example": "2011-01-26T19:06:43Z"
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2011-01-26T19:01:12Z",
- "nullable": true
+ "example": "2011-01-26T19:01:12Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2011-01-26T19:14:43Z",
- "nullable": true
- },
- "allow_rebase_merge": {
- "description": "Whether to allow rebase merges for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "temp_clone_token": {
- "type": "string"
- },
- "allow_squash_merge": {
- "description": "Whether to allow squash merges for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "allow_auto_merge": {
- "description": "Whether to allow Auto-merge to be used on pull requests.",
- "default": false,
- "type": "boolean",
- "example": false
+ "example": "2011-01-26T19:14:43Z"
},
- "delete_branch_on_merge": {
- "description": "Whether to delete head branches when pull requests are merged",
- "default": false,
- "type": "boolean",
- "example": false
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
},
- "allow_merge_commit": {
- "description": "Whether to allow merge commits for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "allow_forking": {
- "description": "Whether to allow forking this repo",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "web_commit_signoff_required": {
- "description": "Whether to require contributors to sign off on web-based commits",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "subscribers_count": {
- "type": "integer"
- },
- "network_count": {
- "type": "integer"
- },
- "open_issues": {
- "type": "integer"
- },
- "watchers": {
- "type": "integer"
- },
- "master_branch": {
- "type": "string"
- }
- },
- "required": [
- "archive_url",
- "assignees_url",
- "blobs_url",
- "branches_url",
- "collaborators_url",
- "comments_url",
- "commits_url",
- "compare_url",
- "contents_url",
- "contributors_url",
- "deployments_url",
- "description",
- "downloads_url",
- "events_url",
- "fork",
- "forks_url",
- "full_name",
- "git_commits_url",
- "git_refs_url",
- "git_tags_url",
- "hooks_url",
- "html_url",
- "id",
- "node_id",
- "issue_comment_url",
- "issue_events_url",
- "issues_url",
- "keys_url",
- "labels_url",
- "languages_url",
- "merges_url",
- "milestones_url",
- "name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url",
- "clone_url",
- "default_branch",
- "forks",
- "forks_count",
- "git_url",
- "has_downloads",
- "has_issues",
- "has_projects",
- "has_wiki",
- "has_pages",
- "homepage",
- "language",
- "archived",
- "disabled",
- "mirror_url",
- "open_issues",
- "open_issues_count",
- "license",
- "pushed_at",
- "size",
- "ssh_url",
- "stargazers_count",
- "svn_url",
- "watchers",
- "watchers_count",
- "created_at",
- "updated_at"
- ]
- },
- "examples": {
- "alternative-response-with-repository-permissions": {
- "value": {
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "private": false,
- "html_url": "https://github.com/octocat/Hello-World",
- "description": "This your first repo!",
- "fork": false,
- "url": "https://api.github.com/repos/octocat/Hello-World",
- "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
- "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
- "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
- "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
- "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
- "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
- "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
- "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
- "git_url": "git:github.com/octocat/Hello-World.git",
- "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
- "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
- "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
- "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
- "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
- "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
- "ssh_url": "git@github.com:octocat/Hello-World.git",
- "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
- "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
- "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
- "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
- "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
- "clone_url": "https://github.com/octocat/Hello-World.git",
- "mirror_url": "git:git.example.com/octocat/Hello-World",
- "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
- "svn_url": "https://svn.github.com/octocat/Hello-World",
- "homepage": "https://github.com",
- "language": null,
- "forks_count": 9,
- "stargazers_count": 80,
- "watchers_count": 80,
- "size": 108,
- "default_branch": "master",
- "open_issues_count": 0,
- "is_template": false,
- "topics": [
- "octocat",
- "atom",
- "electron",
- "api"
- ],
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true,
- "has_pages": false,
- "has_downloads": true,
- "archived": false,
- "disabled": false,
- "visibility": "public",
- "pushed_at": "2011-01-26T19:06:43Z",
- "created_at": "2011-01-26T19:01:12Z",
- "updated_at": "2011-01-26T19:14:43Z",
- "permissions": {
- "admin": false,
- "maintain": false,
- "push": false,
- "triage": false,
- "pull": true
- },
- "role_name": "read",
- "allow_rebase_merge": true,
- "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
- "allow_squash_merge": true,
- "allow_auto_merge": false,
- "delete_branch_on_merge": true,
- "allow_merge_commit": true,
- "subscribers_count": 42,
- "network_count": 0,
- "license": {
- "key": "mit",
- "name": "MIT License",
- "url": "https://api.github.com/licenses/mit",
- "spdx_id": "MIT",
- "node_id": "MDc6TGljZW5zZW1pdA==",
- "html_url": "https://api.github.com/licenses/mit"
- },
- "forks": 1,
- "open_issues": 1,
- "watchers": 1
- }
- }
- }
- }
- }
- },
- "204": {
- "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."
- },
- "404": {
- "description": "Not Found if team does not have permission for the repository"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
- },
- "put": {
- "summary": "Add or update team repository permissions",
- "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/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",
- "example": [
- {
- "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"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "group_description"
- ],
- "properties": {
- "group_id": {
- "description": "The ID of the group",
- "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
- "type": "string"
- },
- "group_name": {
- "description": "The name of the group",
- "example": "saml-azuread-test",
- "type": "string"
- },
- "group_description": {
- "description": "a description of the group",
- "example": "A group of Developers working on AzureAD SAML SSO",
- "type": "string"
- },
- "status": {
- "description": "synchronization status for this group mapping",
- "example": "unsynced",
- "type": "string"
- },
- "synced_at": {
- "description": "the time of the last sync for this group-mapping",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string",
- "nullable": true
- }
- }
- }
- }
- }
- },
- "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",
- "example": [
- {
- "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"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "group_description"
- ],
- "properties": {
- "group_id": {
- "description": "The ID of the group",
- "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
- "type": "string"
- },
- "group_name": {
- "description": "The name of the group",
- "example": "saml-azuread-test",
- "type": "string"
- },
- "group_description": {
- "description": "a description of the group",
- "example": "A group of Developers working on AzureAD SAML SSO",
- "type": "string"
- },
- "status": {
- "description": "synchronization status for this group mapping",
- "example": "unsynced",
- "type": "string"
- },
- "synced_at": {
- "description": "the time of the last sync for this group-mapping",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string",
- "nullable": true
- }
- }
- }
- }
- }
- },
- "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",
- "nullable": true
- },
- "privacy": {
- "type": "string"
- },
- "notification_setting": {
- "type": "string"
- },
- "permission": {
- "type": "string"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "pull",
- "triage",
- "push",
- "maintain",
- "admin"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "members_url": {
- "type": "string"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- }
- },
- "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",
- "example": 1296269
- },
- "node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "type": "string",
- "example": "Hello-World"
- },
- "full_name": {
- "type": "string",
- "example": "octocat/Hello-World"
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
- },
- "description": {
- "type": "string",
- "example": "This your first repo!",
- "nullable": true
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- },
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- },
- "git_url": {
- "type": "string",
- "example": "git:github.com/octocat/Hello-World.git"
- },
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- },
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- },
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- },
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
- "type": "string",
- "example": "git@github.com:octocat/Hello-World.git"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
- },
- "trees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
- },
- "clone_url": {
- "type": "string",
- "example": "https://github.com/octocat/Hello-World.git"
- },
- "mirror_url": {
- "type": "string",
- "format": "uri",
- "example": "git:git.example.com/octocat/Hello-World",
- "nullable": true
- },
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
- },
- "svn_url": {
- "type": "string",
- "format": "uri",
- "example": "https://svn.github.com/octocat/Hello-World"
- },
- "homepage": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com",
- "nullable": true
- },
- "language": {
- "type": "string",
- "nullable": true
- },
- "forks_count": {
- "type": "integer",
- "example": 9
- },
- "stargazers_count": {
- "type": "integer",
- "example": 80
- },
- "watchers_count": {
- "type": "integer",
- "example": 80
- },
- "size": {
- "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
- "type": "integer",
- "example": 108
- },
- "default_branch": {
- "type": "string",
- "example": "master"
- },
- "open_issues_count": {
- "type": "integer",
- "example": 0
- },
- "is_template": {
- "type": "boolean",
- "example": true
- },
- "topics": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "octocat",
- "atom",
- "electron",
- "API"
- ]
- },
- "has_issues": {
- "type": "boolean",
- "example": true
- },
- "has_projects": {
- "type": "boolean",
- "example": true
- },
- "has_wiki": {
- "type": "boolean",
- "example": true
- },
- "has_pages": {
- "type": "boolean"
- },
- "has_downloads": {
- "type": "boolean",
- "example": true
- },
- "has_discussions": {
- "type": "boolean",
- "example": true
- },
- "archived": {
- "type": "boolean"
- },
- "disabled": {
- "type": "boolean",
- "description": "Returns whether or not this repository disabled."
- },
- "visibility": {
- "description": "The repository visibility: public, private, or internal.",
- "type": "string",
- "example": "public"
- },
- "pushed_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:06:43Z"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:01:12Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:14:43Z"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- },
- "required": [
- "admin",
- "pull",
- "push"
- ]
- },
- "allow_rebase_merge": {
+ "allow_rebase_merge": {
"type": "boolean",
"example": true
},
@@ -593078,1068 +591425,170 @@
"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",
- "format": "uri",
- "nullable": true
- },
- "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": {
- "title": "License Simple",
- "description": "License Simple",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "example": "mit"
- },
- "name": {
- "type": "string",
- "example": "MIT License"
- },
- "url": {
- "type": "string",
- "nullable": true,
- "format": "uri",
- "example": "https://api.github.com/licenses/mit"
- },
- "spdx_id": {
- "type": "string",
- "nullable": true,
- "example": "MIT"
- },
- "node_id": {
- "type": "string",
- "example": "MDc6TGljZW5zZW1pdA=="
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "key",
- "name",
- "url",
- "spdx_id",
- "node_id"
- ],
- "nullable": true
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- },
- "required": [
- "admin",
- "pull",
- "push"
- ]
- },
- "text_matches": {
- "title": "Search Result Text Matches",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "object_url": {
- "type": "string"
- },
- "object_type": {
- "nullable": true,
- "type": "string"
- },
- "property": {
- "type": "string"
- },
- "fragment": {
- "type": "string"
- },
- "matches": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- },
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- }
- }
- }
- }
- },
- "temp_clone_token": {
- "type": "string"
- },
- "allow_merge_commit": {
- "type": "boolean"
- },
- "allow_squash_merge": {
- "type": "boolean"
- },
- "allow_rebase_merge": {
- "type": "boolean"
- },
- "allow_auto_merge": {
- "type": "boolean"
- },
- "delete_branch_on_merge": {
- "type": "boolean"
- },
- "allow_forking": {
- "type": "boolean"
- },
- "is_template": {
- "type": "boolean"
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- }
- },
- "required": [
- "archive_url",
- "assignees_url",
- "blobs_url",
- "branches_url",
- "collaborators_url",
- "comments_url",
- "commits_url",
- "compare_url",
- "contents_url",
- "contributors_url",
- "deployments_url",
- "description",
- "downloads_url",
- "events_url",
- "fork",
- "forks_url",
- "full_name",
- "git_commits_url",
- "git_refs_url",
- "git_tags_url",
- "hooks_url",
- "html_url",
- "id",
- "node_id",
- "issue_comment_url",
- "issue_events_url",
- "issues_url",
- "keys_url",
- "labels_url",
- "languages_url",
- "merges_url",
- "milestones_url",
- "name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url",
- "clone_url",
- "default_branch",
- "forks",
- "forks_count",
- "git_url",
- "has_downloads",
- "has_issues",
- "has_projects",
- "has_wiki",
- "has_pages",
- "homepage",
- "language",
- "archived",
- "disabled",
- "mirror_url",
- "open_issues",
- "open_issues_count",
- "license",
- "pushed_at",
- "size",
- "ssh_url",
- "stargazers_count",
- "svn_url",
- "watchers",
- "watchers_count",
- "created_at",
- "updated_at",
- "score"
- ]
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "total_count": 40,
- "incomplete_results": false,
- "items": [
- {
- "id": 3081286,
- "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2",
- "name": "Tetris",
- "full_name": "dtrupenn/Tetris",
- "owner": {
- "login": "dtrupenn",
- "id": 872147,
- "node_id": "MDQ6VXNlcjg3MjE0Nw==",
- "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
- "gravatar_id": "",
- "url": "https://api.github.com/users/dtrupenn",
- "received_events_url": "https://api.github.com/users/dtrupenn/received_events",
- "type": "User",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "site_admin": true
- },
- "private": false,
- "html_url": "https://github.com/dtrupenn/Tetris",
- "description": "A C implementation of Tetris using Pennsim through LC4",
- "fork": false,
- "url": "https://api.github.com/repos/dtrupenn/Tetris",
- "created_at": "2012-01-01T00:31:50Z",
- "updated_at": "2013-01-05T17:58:47Z",
- "pushed_at": "2012-01-01T00:37:02Z",
- "homepage": "https://github.com",
- "size": 524,
- "stargazers_count": 1,
- "watchers_count": 1,
- "language": "Assembly",
- "forks_count": 0,
- "open_issues_count": 0,
- "master_branch": "master",
- "default_branch": "master",
- "score": 1,
- "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}",
- "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}",
- "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors",
- "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments",
- "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads",
- "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events",
- "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks",
- "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}",
- "git_url": "git:github.com/dtrupenn/Tetris.git",
- "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}",
- "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}",
- "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages",
- "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges",
- "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}",
- "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}",
- "ssh_url": "git@github.com:dtrupenn/Tetris.git",
- "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers",
- "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers",
- "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription",
- "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags",
- "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams",
- "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}",
- "clone_url": "https://github.com/dtrupenn/Tetris.git",
- "mirror_url": "git:git.example.com/dtrupenn/Tetris",
- "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks",
- "svn_url": "https://svn.github.com/dtrupenn/Tetris",
- "forks": 1,
- "open_issues": 1,
- "watchers": 1,
- "has_issues": true,
- "has_projects": true,
- "has_pages": true,
- "has_wiki": true,
- "has_downloads": true,
- "archived": true,
- "disabled": true,
- "visibility": "private",
- "license": {
- "key": "mit",
- "name": "MIT License",
- "url": "https://api.github.com/licenses/mit",
- "spdx_id": "MIT",
- "node_id": "MDc6TGljZW5zZW1pdA==",
- "html_url": "https://api.github.com/licenses/mit"
- }
- }
- ]
- }
- }
- }
- }
- }
- },
- "503": {
- "description": "Service unavailable",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "search",
- "subcategory": "search"
- }
- }
- },
- "/search/topics": {
- "get": {
- "summary": "Search topics",
- "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/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",
- "nullable": true
- },
- "short_description": {
- "type": "string",
- "nullable": true
- },
- "description": {
- "type": "string",
- "nullable": true
- },
- "created_by": {
- "type": "string",
- "nullable": true
- },
- "released": {
- "type": "string",
- "nullable": true
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "featured": {
- "type": "boolean"
- },
- "curated": {
- "type": "boolean"
- },
- "score": {
- "type": "number"
- },
- "repository_count": {
- "type": "integer",
- "nullable": true
- },
- "logo_url": {
- "type": "string",
- "format": "uri",
- "nullable": true
- },
- "text_matches": {
- "title": "Search Result Text Matches",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "object_url": {
- "type": "string"
- },
- "object_type": {
- "nullable": true,
- "type": "string"
- },
- "property": {
- "type": "string"
- },
- "fragment": {
- "type": "string"
- },
- "matches": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- },
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- }
- }
- }
- }
- },
- "related": {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "object",
- "properties": {
- "topic_relation": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "topic_id": {
- "type": "integer"
- },
- "relation_type": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "aliases": {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "object",
- "properties": {
- "topic_relation": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "topic_id": {
- "type": "integer"
- },
- "relation_type": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "required": [
- "name",
- "display_name",
- "short_description",
- "description",
- "created_by",
- "released",
- "created_at",
- "updated_at",
- "featured",
- "curated",
- "score"
- ]
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "total_count": 6,
- "incomplete_results": false,
- "items": [
- {
- "name": "ruby",
- "display_name": "Ruby",
- "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.",
- "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.",
- "created_by": "Yukihiro Matsumoto",
- "released": "December 21, 1995",
- "created_at": "2016-11-28T22:03:59Z",
- "updated_at": "2017-10-30T18:16:32Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "rails",
- "display_name": "Rails",
- "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.",
- "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.",
- "created_by": "David Heinemeier Hansson",
- "released": "December 13 2005",
- "created_at": "2016-12-09T17:03:50Z",
- "updated_at": "2017-10-30T16:20:19Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "python",
- "display_name": "Python",
- "short_description": "Python is a dynamically typed programming language.",
- "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.",
- "created_by": "Guido van Rossum",
- "released": "February 20, 1991",
- "created_at": "2016-12-07T00:07:02Z",
- "updated_at": "2017-10-27T22:45:43Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "jekyll",
- "display_name": "Jekyll",
- "short_description": "Jekyll is a simple, blog-aware static site generator.",
- "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.",
- "created_by": "Tom Preston-Werner",
- "released": "2008",
- "created_at": "2016-12-16T21:53:08Z",
- "updated_at": "2017-10-27T19:00:24Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "sass",
- "display_name": "Sass",
- "short_description": "Sass is a stable extension to classic CSS.",
- "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.",
- "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein",
- "released": "November 28, 2006",
- "created_at": "2016-12-16T21:53:45Z",
- "updated_at": "2018-01-16T16:30:40Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "homebrew",
- "display_name": "Homebrew",
- "short_description": "Homebrew is a package manager for macOS.",
- "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.",
- "created_by": "Max Howell",
- "released": "2009",
- "created_at": "2016-12-17T20:30:44Z",
- "updated_at": "2018-02-06T16:14:56Z",
- "featured": true,
- "curated": true,
- "score": 1
- }
- ]
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "search",
- "subcategory": "search"
- }
- }
- },
- "/search/users": {
- "get": {
- "summary": "Search users",
- "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/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",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri"
+ "type": "string"
},
- "html_url": {
+ "merges_url": {
"type": "string",
"format": "uri"
},
- "followers_url": {
- "type": "string",
- "format": "uri"
+ "archive_url": {
+ "type": "string"
},
- "subscriptions_url": {
+ "downloads_url": {
"type": "string",
"format": "uri"
},
- "organizations_url": {
- "type": "string",
- "format": "uri"
+ "issues_url": {
+ "type": "string"
},
- "repos_url": {
- "type": "string",
- "format": "uri"
+ "pulls_url": {
+ "type": "string"
},
- "received_events_url": {
- "type": "string",
- "format": "uri"
+ "milestones_url": {
+ "type": "string"
},
- "type": {
+ "notifications_url": {
"type": "string"
},
- "score": {
- "type": "number"
+ "labels_url": {
+ "type": "string"
},
- "following_url": {
+ "releases_url": {
"type": "string"
},
- "gists_url": {
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
"type": "string"
},
- "starred_url": {
+ "ssh_url": {
"type": "string"
},
- "events_url": {
+ "clone_url": {
"type": "string"
},
- "public_repos": {
- "type": "integer"
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
},
- "public_gists": {
+ "forks": {
"type": "integer"
},
- "followers": {
+ "open_issues": {
"type": "integer"
},
- "following": {
+ "watchers": {
"type": "integer"
},
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "name": {
+ "mirror_url": {
"type": "string",
+ "format": "uri",
"nullable": true
},
- "bio": {
- "type": "string",
- "nullable": true
+ "has_issues": {
+ "type": "boolean"
},
- "email": {
- "type": "string",
- "format": "email",
- "nullable": true
+ "has_projects": {
+ "type": "boolean"
},
- "location": {
- "type": "string",
- "nullable": true
+ "has_pages": {
+ "type": "boolean"
},
- "site_admin": {
+ "has_wiki": {
"type": "boolean"
},
- "hireable": {
+ "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": {
+ "title": "License Simple",
+ "description": "License Simple",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit"
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ],
"nullable": true
},
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
"text_matches": {
"title": "Search Result Text Matches",
"type": "array",
@@ -594179,42 +591628,109 @@
}
}
},
- "blog": {
- "type": "string",
- "nullable": true
+ "temp_clone_token": {
+ "type": "string"
},
- "company": {
- "type": "string",
- "nullable": true
+ "allow_merge_commit": {
+ "type": "boolean"
},
- "suspended_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
+ "allow_squash_merge": {
+ "type": "boolean"
},
- "user_view_type": {
- "type": "string"
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "allow_auto_merge": {
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
}
},
"required": [
- "avatar_url",
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
"events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
"html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
+ "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"
]
}
@@ -594224,29 +591740,112 @@
"examples": {
"default": {
"value": {
- "total_count": 12,
+ "total_count": 40,
"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",
+ "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,
- "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
+ "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"
+ }
}
]
}
@@ -594255,9 +591854,6 @@
}
}
},
- "304": {
- "description": "Not modified"
- },
"503": {
"description": "Service unavailable",
"content": {
@@ -594322,620 +591918,25 @@
"type": "integer"
},
"value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "search",
- "subcategory": "search"
- }
- }
- },
- "/teams/{team_id}": {
- "get": {
- "summary": "Get a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "parent": null,
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "is_verified": true,
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
@@ -594943,693 +591944,791 @@
}
}
},
- "404": {
- "description": "Resource not found",
+ "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": {
- "title": "Basic Error",
- "description": "Basic Error",
"type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
"properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
+ "total_count": {
+ "type": "integer"
},
- "url": {
- "type": "string"
+ "incomplete_results": {
+ "type": "boolean"
},
- "status": {
- "type": "string"
+ "items": {
+ "type": "array",
+ "items": {
+ "title": "Topic Search Result Item",
+ "description": "Topic Search Result Item",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "display_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "short_description": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_by": {
+ "type": "string",
+ "nullable": true
+ },
+ "released": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "featured": {
+ "type": "boolean"
+ },
+ "curated": {
+ "type": "boolean"
+ },
+ "score": {
+ "type": "number"
+ },
+ "repository_count": {
+ "type": "integer",
+ "nullable": true
+ },
+ "logo_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "text_matches": {
+ "title": "Search Result Text Matches",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "object_url": {
+ "type": "string"
+ },
+ "object_type": {
+ "nullable": true,
+ "type": "string"
+ },
+ "property": {
+ "type": "string"
+ },
+ "fragment": {
+ "type": "string"
+ },
+ "matches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "related": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "topic_relation": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "topic_id": {
+ "type": "integer"
+ },
+ "relation_type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "aliases": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "topic_relation": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "topic_id": {
+ "type": "integer"
+ },
+ "relation_type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "name",
+ "display_name",
+ "short_description",
+ "description",
+ "created_by",
+ "released",
+ "created_at",
+ "updated_at",
+ "featured",
+ "curated",
+ "score"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 6,
+ "incomplete_results": false,
+ "items": [
+ {
+ "name": "ruby",
+ "display_name": "Ruby",
+ "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.",
+ "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.",
+ "created_by": "Yukihiro Matsumoto",
+ "released": "December 21, 1995",
+ "created_at": "2016-11-28T22:03:59Z",
+ "updated_at": "2017-10-30T18:16:32Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "rails",
+ "display_name": "Rails",
+ "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.",
+ "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.",
+ "created_by": "David Heinemeier Hansson",
+ "released": "December 13 2005",
+ "created_at": "2016-12-09T17:03:50Z",
+ "updated_at": "2017-10-30T16:20:19Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "python",
+ "display_name": "Python",
+ "short_description": "Python is a dynamically typed programming language.",
+ "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.",
+ "created_by": "Guido van Rossum",
+ "released": "February 20, 1991",
+ "created_at": "2016-12-07T00:07:02Z",
+ "updated_at": "2017-10-27T22:45:43Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "jekyll",
+ "display_name": "Jekyll",
+ "short_description": "Jekyll is a simple, blog-aware static site generator.",
+ "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.",
+ "created_by": "Tom Preston-Werner",
+ "released": "2008",
+ "created_at": "2016-12-16T21:53:08Z",
+ "updated_at": "2017-10-27T19:00:24Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "sass",
+ "display_name": "Sass",
+ "short_description": "Sass is a stable extension to classic CSS.",
+ "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.",
+ "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein",
+ "released": "November 28, 2006",
+ "created_at": "2016-12-16T21:53:45Z",
+ "updated_at": "2018-01-16T16:30:40Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "homebrew",
+ "display_name": "Homebrew",
+ "short_description": "Homebrew is a package manager for macOS.",
+ "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.",
+ "created_by": "Max Howell",
+ "released": "2009",
+ "created_at": "2016-12-17T20:30:44Z",
+ "updated_at": "2018-02-06T16:14:56Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ }
+ ]
}
}
}
}
}
+ },
+ "304": {
+ "description": "Not modified"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "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`.",
+ "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": [
- "teams"
+ "search"
],
- "operationId": "teams/update-legacy",
+ "operationId": "search/users",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-users"
},
"parameters": [
{
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub 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": "integer"
+ "type": "string"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the team."
- },
- "description": {
- "type": "string",
- "description": "The description of the team."
- },
- "privacy": {
- "type": "string",
- "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
- "enum": [
- "secret",
- "closed"
- ]
- },
- "notification_setting": {
- "type": "string",
- "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ]
- },
- "permission": {
- "type": "string",
- "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.",
- "enum": [
- "pull",
- "push",
- "admin"
- ],
- "default": "pull"
- },
- "parent_team_id": {
- "type": "integer",
- "description": "The ID of a team to set as the parent team.",
- "nullable": true
- }
- },
- "required": [
- "name"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed",
- "notification_setting": "notifications_enabled"
- }
- }
- }
+ },
+ {
+ "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 when the updated information already exists",
+ "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",
- "example": 42,
+ "total_count": {
"type": "integer"
},
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
+ "incomplete_results": {
+ "type": "boolean"
},
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
+ "items": {
+ "type": "array",
+ "items": {
+ "title": "User Search Result Item",
+ "description": "User Search Result Item",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "score": {
+ "type": "number"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "public_repos": {
+ "type": "integer"
+ },
+ "public_gists": {
+ "type": "integer"
+ },
+ "followers": {
+ "type": "integer"
+ },
+ "following": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "bio": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "nullable": true
+ },
+ "location": {
+ "type": "string",
+ "nullable": true
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "hireable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "text_matches": {
+ "title": "Search Result Text Matches",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "object_url": {
+ "type": "string"
+ },
+ "object_type": {
+ "nullable": true,
+ "type": "string"
+ },
+ "property": {
+ "type": "string"
+ },
+ "fragment": {
+ "type": "string"
+ },
+ "matches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ }
}
},
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
+ "blog": {
+ "type": "string",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "nullable": true
+ },
+ "suspended_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "user_view_type": {
+ "type": "string"
+ }
},
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url",
+ "score"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 12,
+ "incomplete_results": false,
+ "items": [
+ {
+ "login": "mojombo",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/mojombo",
+ "html_url": "https://github.com/mojombo",
+ "followers_url": "https://api.github.com/users/mojombo/followers",
+ "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
+ "organizations_url": "https://api.github.com/users/mojombo/orgs",
+ "repos_url": "https://api.github.com/users/mojombo/repos",
+ "received_events_url": "https://api.github.com/users/mojombo/received_events",
+ "type": "User",
+ "score": 1,
+ "following_url": "https://api.github.com/users/mojombo/following{/other_user}",
+ "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
+ "events_url": "https://api.github.com/users/mojombo/events{/privacy}",
+ "site_admin": true
}
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not modified"
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
},
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
+ "message": {
+ "type": "string"
},
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
+ "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": [
- "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"
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
- },
- "201": {
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/teams/{team_id}": {
+ "get": {
+ "summary": "Get a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "description": "The unique identifier of the team.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
@@ -596060,792 +593159,159 @@
"type": "string",
"format": "date-time"
},
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "parent": null,
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "is_verified": true,
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "404": {
- "description": "Resource not found",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "required": [
+ "login",
+ "url",
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
},
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
+ "updated_at",
+ "members_count",
+ "repos_count",
+ "organization"
+ ]
},
"examples": {
"default": {
- "value": [
- {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "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"
}
- ]
+ }
}
}
}
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
"schema": {
- "type": "string"
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
}
}
}
@@ -596857,20 +593323,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"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.",
+ "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/create-discussion-legacy",
+ "operationId": "teams/update-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy"
},
"parameters": [
{
@@ -596890,30 +593356,57 @@
"schema": {
"type": "object",
"properties": {
- "title": {
+ "name": {
"type": "string",
- "description": "The discussion post's title."
+ "description": "The name of the team."
},
- "body": {
+ "description": {
"type": "string",
- "description": "The discussion post's body text."
+ "description": "The description of the team."
},
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
+ "enum": [
+ "secret",
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "permission": {
+ "type": "string",
+ "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "default": "pull"
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team.",
+ "nullable": true
}
},
"required": [
- "title",
- "body"
+ "name"
]
},
"examples": {
"default": {
"value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
}
}
}
@@ -596921,1096 +593414,1250 @@
}
},
"responses": {
- "201": {
- "description": "Response",
+ "200": {
+ "description": "Response when the updated information already exists",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"example": 1
},
"node_id": {
"type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
+ "members_count": {
+ "type": "integer",
+ "example": 3
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "example": "github"
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/blog"
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "github",
+ "nullable": true
+ },
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
+ "type": "string",
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "nullable": true
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "example": "all"
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
+ "login",
"url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "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",
- "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": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
+ "201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"example": 1
},
"node_id": {
"type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
+ "members_count": {
+ "type": "integer",
+ "example": 3
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
- "url": {
+ "login": {
"type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
+ "example": "github"
},
- "confused": {
- "type": "integer"
+ "id": {
+ "type": "integer",
+ "example": 1
},
- "heart": {
- "type": "integer"
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
},
- "hooray": {
- "type": "integer"
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "eyes": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "login": {
+ "issues_url": {
"type": "string",
- "example": "octocat"
+ "example": "https://api.github.com/orgs/github/issues"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "node_id": {
+ "public_members_url": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
"avatar_url": {
"type": "string",
- "format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
- "gravatar_id": {
+ "description": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
+ "example": "A great organization",
"nullable": true
},
- "url": {
+ "name": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "github"
},
- "html_url": {
+ "company": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "GitHub"
},
- "followers_url": {
+ "blog": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "https://github.com/blog"
},
- "following_url": {
+ "location": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "San Francisco"
},
- "gists_url": {
+ "email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "format": "email",
+ "example": "octocat@github.com"
},
- "starred_url": {
+ "twitter_username": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "github",
+ "nullable": true
},
- "subscriptions_url": {
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "https://github.com/octocat"
},
- "organizations_url": {
+ "created_at": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
},
- "repos_url": {
+ "type": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "Organization"
},
- "events_url": {
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
},
- "received_events_url": {
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "nullable": true
},
- "type": {
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
"type": "string",
- "example": "User"
+ "example": "all"
},
- "site_admin": {
- "type": "boolean"
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
},
- "starred_at": {
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "format": "date-time"
},
- "user_view_type": {
+ "archived_at": {
"type": "string",
- "example": "public"
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
+ "login",
+ "url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
"repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
"type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
},
- "team_url": {
+ "ldap_dn": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
},
- "updated_at": {
+ "type": {
+ "description": "The ownership type of the team",
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "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",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -598019,20 +594666,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": [
{
@@ -598043,20 +594690,106 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -598065,7 +594798,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
}
diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml
index 88a61276e..1bcaefc93 100644
--- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml
+++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml
@@ -1029,7 +1029,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &755
+ - &752
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -1713,7 +1713,7 @@ paths:
application/json:
schema: *3
application/scim+json:
- schema: &765
+ schema: &762
title: Scim Error
description: Scim Error
type: object
@@ -8897,7 +8897,7 @@ paths:
value:
days: 90
maximum_allowed_days: 365
- '401': &766
+ '401': &763
description: Authorization failure
'404': *6
x-github:
@@ -13108,7 +13108,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &533
+ instances_url: &530
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -13143,7 +13143,7 @@ paths:
format: date-time
readOnly: true
nullable: true
- dismissed_reason: &534
+ dismissed_reason: &531
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -13152,13 +13152,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &535
+ dismissed_comment: &532
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &536
+ rule: &533
type: object
properties:
id:
@@ -13211,7 +13211,7 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &537
+ tool: &534
type: object
properties:
name: *111
@@ -13221,26 +13221,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *112
- most_recent_instance: &538
+ most_recent_instance: &535
type: object
properties:
- ref: &531
+ ref: &528
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &548
+ analysis_key: &545
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: &549
+ environment: &546
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: &550
+ category: &547
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -13254,7 +13254,7 @@ paths:
properties:
text:
type: string
- location: &551
+ location: &548
type: object
description: Describe a region within a file for the alert.
properties:
@@ -13275,7 +13275,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &552
+ items: &549
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -16939,7 +16939,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
- - &593
+ - &590
name: has
in: query
description: |-
@@ -17052,7 +17052,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &594
+ security_advisory: &591
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -17284,14 +17284,14 @@ paths:
nullable: true
maxLength: 280
fixed_at: *138
- auto_dismissed_at: &595
+ auto_dismissed_at: &592
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &596
+ dismissal_request: &593
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -20776,7 +20776,7 @@ paths:
- *165
rules:
type: array
- items: &721
+ items: &718
title: Repository Rule
type: object
description: A repository rule.
@@ -20785,7 +20785,7 @@ paths:
- *171
- *172
- *173
- - &719
+ - &716
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -21348,14 +21348,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &733
+ state: &730
description: Sets the state of the secret scanning alert. You
must provide `resolution` when you set the state to `resolved`.
type: string
enum:
- open
- resolved
- resolution: &734
+ resolution: &731
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -21462,8 +21462,8 @@ paths:
pull request.
'
- oneOf: &735
- - &737
+ oneOf: &732
+ - &734
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -21515,7 +21515,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &738
+ - &735
description: Represents a 'wiki_commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository wiki.
@@ -21570,7 +21570,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &739
+ - &736
description: Represents an 'issue_title' secret scanning location
type. This location type shows that a secret was detected
in the title of an issue.
@@ -21584,7 +21584,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &740
+ - &737
description: Represents an 'issue_body' secret scanning location
type. This location type shows that a secret was detected
in the body of an issue.
@@ -21598,7 +21598,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &741
+ - &738
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on an issue.
@@ -21612,7 +21612,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &742
+ - &739
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a discussion.
@@ -21626,7 +21626,7 @@ paths:
example: https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &743
+ - &740
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a discussion.
@@ -21640,7 +21640,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &744
+ - &741
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a discussion.
@@ -21654,7 +21654,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &745
+ - &742
description: Represents a 'pull_request_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a pull request.
@@ -21668,7 +21668,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &746
+ - &743
description: Represents a 'pull_request_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a pull request.
@@ -21682,7 +21682,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &747
+ - &744
description: Represents a 'pull_request_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a pull request.
@@ -21696,7 +21696,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &748
+ - &745
description: Represents a 'pull_request_review' secret scanning
location type. This location type shows that a secret was
detected in a review on a pull request.
@@ -21710,7 +21710,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &749
+ - &746
description: Represents a 'pull_request_review_comment' secret
scanning location type. This location type shows that a
secret was detected in a review comment on a pull request.
@@ -25004,7 +25004,7 @@ paths:
properties:
action:
type: string
- discussion: &873
+ discussion: &868
title: Discussion
description: A Discussion in a repository.
type: object
@@ -25371,7 +25371,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &657
+ properties: &654
id:
type: integer
format: int64
@@ -25748,7 +25748,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &793
+ sub_issues_summary: &790
title: Sub-issues Summary
type: object
properties:
@@ -25768,7 +25768,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &794
+ issue_dependencies_summary: &791
title: Issue Dependencies Summary
type: object
properties:
@@ -25787,7 +25787,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &795
+ items: &792
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -25848,7 +25848,7 @@ paths:
- node_id
- data_type
- value
- required: &658
+ required: &655
- assignee
- closed_at
- comments
@@ -25886,7 +25886,7 @@ paths:
action:
type: string
issue: *221
- comment: &653
+ comment: &650
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -26605,7 +26605,7 @@ paths:
type: string
release:
allOf:
- - &712
+ - &709
title: Release
description: A release.
type: object
@@ -26676,7 +26676,7 @@ paths:
author: *4
assets:
type: array
- items: &713
+ items: &710
title: Release Asset
description: Data related to a release.
type: object
@@ -27255,7 +27255,7 @@ paths:
url:
type: string
format: uri
- user: &803
+ user: &798
title: Public User
description: Public User
type: object
@@ -30560,14 +30560,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:
- - &459
+ - &456
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &460
+ - &457
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -30629,7 +30629,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &465
+ '301': &462
description: Moved permanently
content:
application/json:
@@ -30651,7 +30651,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &686
+ - &683
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -30659,7 +30659,7 @@ paths:
schema:
type: boolean
default: false
- - &687
+ - &684
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -30669,7 +30669,7 @@ paths:
type: boolean
default: false
- *228
- - &688
+ - &685
name: before
description: 'Only show notifications updated before the given time. This
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
@@ -31151,7 +31151,7 @@ paths:
- url
- subscription_url
examples:
- default: &689
+ default: &686
value:
- id: '1'
repository:
@@ -32268,7 +32268,7 @@ paths:
type: array
items: *156
examples:
- default: &695
+ default: &692
value:
- property_name: environment
value: production
@@ -32318,7 +32318,7 @@ paths:
required:
- properties
examples:
- default: &696
+ default: &693
value:
properties:
- property_name: environment
@@ -33131,7 +33131,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &472
+ items: &469
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -35245,7 +35245,7 @@ paths:
type: array
items: *284
examples:
- default: &806
+ default: &801
value:
total_count: 1
repositories:
@@ -36287,7 +36287,7 @@ paths:
description: Response
content:
application/json:
- schema: &492
+ schema: &489
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -36316,7 +36316,7 @@ paths:
- key_id
- key
examples:
- default: &493
+ default: &490
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -36729,7 +36729,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables
parameters:
- *87
- - &477
+ - &474
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)."
@@ -37944,12 +37944,12 @@ paths:
required:
- subject_digests
examples:
- default: &834
+ default: &829
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &835
+ withPredicateType: &830
value:
subject_digests:
- sha256:abc123
@@ -38007,7 +38007,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &836
+ default: &831
value:
attestations_subject_digests:
- sha256:abc:
@@ -38356,7 +38356,7 @@ paths:
initiator:
type: string
examples:
- default: &506
+ default: &503
value:
attestations:
- bundle:
@@ -39273,7 +39273,7 @@ paths:
be returned.
in: query
required: false
- schema: &532
+ schema: &529
type: string
description: Severity of a code scanning alert.
enum:
@@ -40328,7 +40328,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &564
+ properties: &561
name:
type: string
description: The name of the machine.
@@ -40370,7 +40370,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &565
+ required: &562
- name
- display_name
- operating_system
@@ -41238,7 +41238,7 @@ paths:
- updated_at
- visibility
examples:
- default: &566
+ default: &563
value:
total_count: 2
secrets:
@@ -41276,7 +41276,7 @@ paths:
description: Response
content:
application/json:
- schema: &567
+ schema: &564
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -41305,7 +41305,7 @@ paths:
- key_id
- key
examples:
- default: &568
+ default: &565
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -41337,7 +41337,7 @@ paths:
application/json:
schema: *327
examples:
- default: &570
+ default: &567
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -43196,7 +43196,7 @@ paths:
description: Response
content:
application/json:
- schema: &599
+ schema: &596
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -43213,7 +43213,7 @@ paths:
- key_id
- key
examples:
- default: &600
+ default: &597
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -43543,7 +43543,7 @@ paths:
subcategory: alert-dismissal-requests
parameters:
- *87
- - &608
+ - &605
name: reviewer
description: Filter alert dismissal requests by the handle of the GitHub user
who reviewed the dismissal request.
@@ -43551,7 +43551,7 @@ paths:
required: false
schema:
type: string
- - &609
+ - &606
name: requester
description: Filter alert dismissal requests by the handle of the GitHub user
who requested the dismissal.
@@ -43559,7 +43559,7 @@ paths:
required: false
schema:
type: string
- - &610
+ - &607
name: time_period
description: |-
The time period to filter by.
@@ -43575,7 +43575,7 @@ paths:
- week
- month
default: month
- - &611
+ - &608
name: request_status
description: Filter alert dismissal requests by status. When specified, only
requests with this status will be returned.
@@ -43600,7 +43600,7 @@ paths:
application/json:
schema:
type: array
- items: &612
+ items: &609
title: Code scanning alert dismissal request
description: Alert dismisal request made by a user asking to dismiss
a code scanning alert.
@@ -43756,7 +43756,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/code-scanning/alerts/1
examples:
- default: &613
+ default: &610
value:
- id: 21
number: 42
@@ -43874,7 +43874,7 @@ paths:
application/json:
schema:
type: array
- items: &614
+ items: &611
title: Dependabot alert dismissal request
description: Alert dismissal request made by a user asking to dismiss
a Dependabot alert.
@@ -43991,7 +43991,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/security/dependabot/1
examples:
- default: &615
+ default: &612
value:
- id: 21
number: 42
@@ -44093,7 +44093,7 @@ paths:
application/json:
schema:
type: array
- items: &616
+ items: &613
title: Secret scanning alert dismissal request
description: A dismissal request made by a user asking to close
a secret scanning alert in this repository.
@@ -44214,7 +44214,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/security/secret-scanning/17
examples:
- default: &617
+ default: &614
value:
- id: 21
number: 42
@@ -44559,7 +44559,7 @@ paths:
description: Response
content:
application/json:
- schema: &456
+ schema: &453
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -44640,7 +44640,7 @@ paths:
example: mona_lisa@github.com
type: string
examples:
- default: &457
+ default: &454
value:
group_id: '123'
group_name: Octocat admins
@@ -44695,7 +44695,7 @@ paths:
description: Response
content:
application/json:
- schema: &454
+ schema: &451
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -44732,7 +44732,7 @@ paths:
example: 2019-06-03 22:27:15:000 -700
type: string
examples:
- default: &455
+ default: &452
value:
groups:
- group_id: '123'
@@ -46034,7 +46034,7 @@ paths:
application/json:
schema: *22
examples:
- default: &648
+ default: &645
value:
id: 1
account:
@@ -46259,7 +46259,7 @@ paths:
required: true
content:
application/json:
- schema: &649
+ schema: &646
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -47120,7 +47120,7 @@ paths:
application/json:
schema: *376
examples:
- default: &563
+ default: &560
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -48369,7 +48369,7 @@ paths:
parameters:
- *87
- *382
- - &819
+ - &814
name: repo_name
description: repo_name parameter
in: path
@@ -49695,7 +49695,7 @@ paths:
- nuget
- container
- *87
- - &820
+ - &815
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -49736,7 +49736,7 @@ paths:
default: *388
'403': *29
'401': *25
- '400': &822
+ '400': &817
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -51528,7 +51528,7 @@ paths:
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: &909
+ properties: &904
id:
type: number
description: The unique identifier of the status update.
@@ -51576,7 +51576,7 @@ paths:
example: The project is off to a great start!
type: string
nullable: true
- required: &910
+ required: &905
- id
- node_id
- created_at
@@ -51790,7 +51790,7 @@ paths:
content:
oneOf:
- *221
- - &580
+ - &577
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -52019,7 +52019,7 @@ paths:
- review_comment
- self
author_association: *222
- auto_merge: &698
+ auto_merge: &695
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -52394,7 +52394,7 @@ paths:
- updated_at
- project_url
examples:
- default: &839
+ default: &834
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -52571,7 +52571,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &840
+ items: &835
type: object
properties:
name:
@@ -52607,7 +52607,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &841
+ iteration_configuration: &836
type: object
description: The configuration for iteration fields.
properties:
@@ -52656,7 +52656,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &842
+ single_select_field: &837
summary: Create a single select field
value:
name: Priority
@@ -52683,7 +52683,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &843
+ iteration_field: &838
summary: Create an iteration field
value:
name: Sprint
@@ -52709,7 +52709,7 @@ paths:
application/json:
schema: *409
examples:
- text_field: &844
+ text_field: &839
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -52718,7 +52718,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-05-15T08:00:00Z'
updated_at: '2022-05-15T08:00:00Z'
- number_field: &845
+ number_field: &840
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -52727,7 +52727,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-01T14:30:00Z'
updated_at: '2022-06-01T14:30:00Z'
- date_field: &846
+ date_field: &841
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -52736,7 +52736,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-10T09:15:00Z'
updated_at: '2022-06-10T09:15:00Z'
- single_select_field: &847
+ single_select_field: &842
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -52770,7 +52770,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &848
+ iteration_field: &843
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -52816,7 +52816,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization
parameters:
- *405
- - &849
+ - &844
name: field_id
description: The unique identifier of the field.
in: path
@@ -52831,7 +52831,7 @@ paths:
application/json:
schema: *409
examples:
- default: &850
+ default: &845
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -53957,7 +53957,7 @@ paths:
parameters:
- *405
- *87
- - &851
+ - &846
name: view_number
description: The number that identifies the project view.
in: path
@@ -54723,7 +54723,7 @@ paths:
description: Response
content:
application/json:
- schema: &464
+ schema: &461
title: Full Repository
description: Full Repository
type: object
@@ -55116,7 +55116,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &585
+ properties: &582
url:
type: string
format: uri
@@ -55132,7 +55132,7 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &586
+ required: &583
- url
- key
- name
@@ -55221,7 +55221,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &466
+ default: &463
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -55774,7 +55774,7 @@ paths:
- *87
- *17
- *19
- - &720
+ - &717
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -55989,7 +55989,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *87
- - &722
+ - &719
name: ref
description: The name of the ref. Cannot contain wildcard characters. Optionally
prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit
@@ -56001,14 +56001,14 @@ paths:
x-multi-segment: true
- *310
- *105
- - &723
+ - &720
name: actor_name
description: The handle for the GitHub user account to filter on. When specified,
only rule evaluations triggered by this actor will be returned.
in: query
schema:
type: string
- - &724
+ - &721
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -56028,7 +56028,7 @@ paths:
description: Response
content:
application/json:
- schema: &725
+ schema: &722
title: Rule Suites
description: Response
type: array
@@ -56083,7 +56083,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &726
+ default: &723
value:
- id: 21
actor_id: 12
@@ -56127,7 +56127,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *87
- - &727
+ - &724
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -56143,7 +56143,7 @@ paths:
description: Response
content:
application/json:
- schema: &728
+ schema: &725
title: Rule Suite
description: Response
type: object
@@ -56242,7 +56242,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &729
+ default: &726
value:
id: 21
actor_id: 12
@@ -56574,7 +56574,7 @@ paths:
- *110
- *19
- *17
- - &731
+ - &728
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -56584,7 +56584,7 @@ paths:
required: false
schema:
type: string
- - &732
+ - &729
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -56797,7 +56797,7 @@ paths:
application/json:
schema:
type: array
- items: &753
+ items: &750
description: A repository security advisory.
type: object
properties:
@@ -57088,7 +57088,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &754
+ default: &751
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -58097,7 +58097,7 @@ paths:
description: Response
content:
application/json:
- schema: &461
+ schema: &458
title: GroupMapping
description: External Groups to be mapped to a team for membership
type: object
@@ -58143,7 +58143,7 @@ paths:
type: string
nullable: true
examples:
- default: &462
+ default: &459
value:
groups:
- group_id: '123'
@@ -58885,454 +58885,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions
- parameters:
- - *87
- - *216
- - *110
- - *17
- - *19
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &451
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form
- conversation within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *20
- required: *21
- nullable: true
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a
- team
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned
- for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted
- to team members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions: *223
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
- examples:
- default: &797
- value:
- - author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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: *47
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion
- parameters:
- - *87
- - *216
- 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: *451
- examples:
- default: &452
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Our first team post
- updated_at: '2018-01-25T18:56:31Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion
- parameters:
- - *87
- - *216
- - &453
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *451
- examples:
- default: *452
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion
- parameters:
- - *87
- - *216
- - *453
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *451
- examples:
- default: &798
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Welcome to our first team post
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion
- parameters:
- - *87
- - *216
- - *453
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -59354,9 +58906,9 @@ paths:
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: *455
+ default: *452
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -59399,9 +58951,9 @@ paths:
description: Response
content:
application/json:
- schema: *456
+ schema: *453
examples:
- default: *457
+ default: *454
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -59542,7 +59094,7 @@ paths:
description: Response
content:
application/json:
- schema: &458
+ schema: &455
title: Team Membership
description: Team Membership
type: object
@@ -59569,7 +59121,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &799
+ response-if-user-is-a-team-maintainer: &794
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -59632,9 +59184,9 @@ paths:
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- response-if-users-membership-with-team-is-now-pending: &800
+ response-if-users-membership-with-team-is-now-pending: &795
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -59741,14 +59293,14 @@ paths:
parameters:
- *87
- *216
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &801
+ schema: &796
title: Team Repository
description: A team's access to a repository.
type: object
@@ -60319,8 +59871,8 @@ paths:
parameters:
- *87
- *216
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -60367,8 +59919,8 @@ paths:
parameters:
- *87
- *216
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -60401,9 +59953,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: *462
+ default: *459
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -60469,7 +60021,7 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
default:
value:
@@ -60514,7 +60066,7 @@ paths:
type: array
items: *313
examples:
- response-if-child-teams-exist: &802
+ response-if-child-teams-exist: &797
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -60668,7 +60220,7 @@ paths:
resources:
type: object
properties:
- core: &463
+ core: &460
title: Rate Limit
type: object
properties:
@@ -60685,21 +60237,21 @@ paths:
- remaining
- reset
- used
- graphql: *463
- search: *463
- code_search: *463
- source_import: *463
- integration_manifest: *463
- code_scanning_upload: *463
- actions_runner_registration: *463
- scim: *463
- dependency_snapshots: *463
- dependency_sbom: *463
- code_scanning_autofix: *463
+ graphql: *460
+ search: *460
+ code_search: *460
+ source_import: *460
+ integration_manifest: *460
+ code_scanning_upload: *460
+ actions_runner_registration: *460
+ scim: *460
+ dependency_snapshots: *460
+ dependency_sbom: *460
+ code_scanning_autofix: *460
required:
- core
- search
- rate: *463
+ rate: *460
required:
- rate
- resources
@@ -60804,14 +60356,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default-response:
summary: Default response
@@ -61316,7 +60868,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *465
+ '301': *462
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61334,8 +60886,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -61592,10 +61144,10 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
- '307': &467
+ default: *463
+ '307': &464
description: Temporary Redirect
content:
application/json:
@@ -61624,8 +61176,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -61647,7 +61199,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': *467
+ '307': *464
'404': *6
'409': *119
x-github:
@@ -61671,11 +61223,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
- - &484
+ - &481
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -61698,7 +61250,7 @@ paths:
type: integer
artifacts:
type: array
- items: &468
+ items: &465
title: Artifact
description: An artifact
type: object
@@ -61776,7 +61328,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &485
+ default: &482
value:
total_count: 2
artifacts:
@@ -61837,9 +61389,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact
parameters:
- - *459
- - *460
- - &469
+ - *456
+ - *457
+ - &466
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -61851,7 +61403,7 @@ paths:
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -61889,9 +61441,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact
parameters:
- - *459
- - *460
- - *469
+ - *456
+ - *457
+ - *466
responses:
'204':
description: Response
@@ -61915,9 +61467,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact
parameters:
- - *459
- - *460
- - *469
+ - *456
+ - *457
+ - *466
- name: archive_format
in: path
required: true
@@ -61931,7 +61483,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': &652
+ '410': &649
description: Gone
content:
application/json:
@@ -61956,14 +61508,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &470
+ schema: &467
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -61996,13 +61548,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
application/json:
- schema: *470
+ schema: *467
examples:
selected_actions: *44
responses:
@@ -62031,14 +61583,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &471
+ schema: &468
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -62071,13 +61623,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
application/json:
- schema: *471
+ schema: *468
examples:
selected_actions: *46
responses:
@@ -62108,14 +61660,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *472
+ schema: *469
examples:
default:
value:
@@ -62141,11 +61693,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:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
- - &473
+ - &470
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
@@ -62179,7 +61731,7 @@ paths:
description: Response
content:
application/json:
- schema: &474
+ schema: &471
title: Repository actions caches
description: Repository actions caches
type: object
@@ -62221,7 +61773,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &475
+ default: &472
value:
total_count: 1
actions_caches:
@@ -62253,23 +61805,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:
- - *459
- - *460
+ - *456
+ - *457
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *473
+ - *470
responses:
'200':
description: Response
content:
application/json:
- schema: *474
+ schema: *471
examples:
- default: *475
+ default: *472
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62289,8 +61841,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:
- - *459
- - *460
+ - *456
+ - *457
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -62321,9 +61873,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:
- - *459
- - *460
- - &476
+ - *456
+ - *457
+ - &473
name: job_id
description: The unique identifier of the job.
in: path
@@ -62335,7 +61887,7 @@ paths:
description: Response
content:
application/json:
- schema: &488
+ schema: &485
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -62642,9 +62194,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:
- - *459
- - *460
- - *476
+ - *456
+ - *457
+ - *473
responses:
'302':
description: Response
@@ -62672,9 +62224,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:
- - *459
- - *460
- - *476
+ - *456
+ - *457
+ - *473
requestBody:
required: false
content:
@@ -62719,8 +62271,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Status response
@@ -62770,8 +62322,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -62834,8 +62386,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -62853,7 +62405,7 @@ paths:
type: integer
secrets:
type: array
- items: &490
+ items: &487
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -62873,7 +62425,7 @@ paths:
- created_at
- updated_at
examples:
- default: &491
+ default: &488
value:
total_count: 2
secrets:
@@ -62906,9 +62458,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables
parameters:
- - *459
- - *460
- - *477
+ - *456
+ - *457
+ - *474
- *19
responses:
'200':
@@ -62925,7 +62477,7 @@ paths:
type: integer
variables:
type: array
- items: &494
+ items: &491
title: Actions Variable
type: object
properties:
@@ -62955,7 +62507,7 @@ paths:
- created_at
- updated_at
examples:
- default: &495
+ default: &492
value:
total_count: 2
variables:
@@ -62988,8 +62540,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -62998,7 +62550,7 @@ paths:
schema:
type: object
properties:
- enabled: &478
+ enabled: &475
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *60
@@ -63033,8 +62585,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -63045,7 +62597,7 @@ paths:
schema:
type: object
properties:
- enabled: *478
+ enabled: *475
allowed_actions: *60
sha_pinning_required: *61
required:
@@ -63078,14 +62630,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &479
+ schema: &476
type: object
properties:
access_level:
@@ -63103,7 +62655,7 @@ paths:
required:
- access_level
examples:
- default: &480
+ default: &477
value:
access_level: organization
x-github:
@@ -63128,15 +62680,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
application/json:
- schema: *479
+ schema: *476
examples:
- default: *480
+ default: *477
responses:
'204':
description: Response
@@ -63160,8 +62712,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63191,8 +62743,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Empty response for successful settings update
@@ -63226,8 +62778,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63254,8 +62806,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -63289,8 +62841,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63318,8 +62870,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -63350,8 +62902,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63382,8 +62934,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -63415,8 +62967,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63445,8 +62997,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Success response
@@ -63486,8 +63038,8 @@ paths:
in: query
schema:
type: string
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -63531,8 +63083,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63564,8 +63116,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -63639,8 +63191,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'201':
description: Response
@@ -63676,8 +63228,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'201':
description: Response
@@ -63707,8 +63259,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
responses:
'200':
@@ -63738,8 +63290,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
responses:
'204':
@@ -63766,8 +63318,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
responses:
'200': *81
@@ -63792,8 +63344,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
requestBody:
required: true
@@ -63842,8 +63394,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
requestBody:
required: true
@@ -63893,8 +63445,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
responses:
'200': *291
@@ -63924,8 +63476,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
- *292
responses:
@@ -63955,9 +63507,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:
- - *459
- - *460
- - &498
+ - *456
+ - *457
+ - &495
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.
@@ -63965,7 +63517,7 @@ paths:
required: false
schema:
type: string
- - &499
+ - &496
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -63973,7 +63525,7 @@ paths:
required: false
schema:
type: string
- - &500
+ - &497
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -63982,7 +63534,7 @@ paths:
required: false
schema:
type: string
- - &501
+ - &498
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
@@ -64009,7 +63561,7 @@ paths:
- pending
- *17
- *19
- - &502
+ - &499
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)."
@@ -64018,7 +63570,7 @@ paths:
schema:
type: string
format: date-time
- - &481
+ - &478
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -64027,13 +63579,13 @@ paths:
schema:
type: boolean
default: false
- - &503
+ - &500
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &504
+ - &501
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -64056,7 +63608,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &482
+ items: &479
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -64204,7 +63756,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &526
+ properties: &523
id:
type: string
description: SHA for the commit
@@ -64255,7 +63807,7 @@ paths:
- name
- email
nullable: true
- required: &527
+ required: &524
- id
- tree_id
- message
@@ -64302,7 +63854,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &505
+ default: &502
value:
total_count: 1
workflow_runs:
@@ -64538,24 +64090,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *459
- - *460
- - &483
+ - *456
+ - *457
+ - &480
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *481
+ - *478
responses:
'200':
description: Response
content:
application/json:
- schema: *482
+ schema: *479
examples:
- default: &486
+ default: &483
value:
id: 30433642
name: Build
@@ -64796,9 +64348,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'204':
description: Response
@@ -64821,9 +64373,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'200':
description: Response
@@ -64942,9 +64494,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'201':
description: Response
@@ -64977,12 +64529,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
- *17
- *19
- - *484
+ - *481
responses:
'200':
description: Response
@@ -64998,9 +64550,9 @@ paths:
type: integer
artifacts:
type: array
- items: *468
+ items: *465
examples:
- default: *485
+ default: *482
headers:
Link: *47
x-github:
@@ -65024,25 +64576,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *459
- - *460
- - *483
- - &487
+ - *456
+ - *457
+ - *480
+ - &484
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *481
+ - *478
responses:
'200':
description: Response
content:
application/json:
- schema: *482
+ schema: *479
examples:
- default: *486
+ default: *483
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65065,10 +64617,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:
- - *459
- - *460
- - *483
- - *487
+ - *456
+ - *457
+ - *480
+ - *484
- *17
- *19
responses:
@@ -65086,9 +64638,9 @@ paths:
type: integer
jobs:
type: array
- items: *488
+ items: *485
examples:
- default: &489
+ default: &486
value:
total_count: 1
jobs:
@@ -65201,10 +64753,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *459
- - *460
- - *483
- - *487
+ - *456
+ - *457
+ - *480
+ - *484
responses:
'302':
description: Response
@@ -65232,9 +64784,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'202':
description: Response
@@ -65267,9 +64819,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
requestBody:
required: true
content:
@@ -65336,9 +64888,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'202':
description: Response
@@ -65371,9 +64923,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
- 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
@@ -65403,9 +64955,9 @@ paths:
type: integer
jobs:
type: array
- items: *488
+ items: *485
examples:
- default: *489
+ default: *486
headers:
Link: *47
x-github:
@@ -65430,9 +64982,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'302':
description: Response
@@ -65459,9 +65011,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'204':
description: Response
@@ -65488,9 +65040,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'200':
description: Response
@@ -65550,7 +65102,7 @@ paths:
items:
type: object
properties:
- type: &618
+ type: &615
type: string
description: The type of reviewer.
enum:
@@ -65635,9 +65187,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
requestBody:
required: true
content:
@@ -65684,7 +65236,7 @@ paths:
application/json:
schema:
type: array
- items: &603
+ items: &600
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -65790,7 +65342,7 @@ paths:
- created_at
- updated_at
examples:
- default: &604
+ default: &601
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -65846,9 +65398,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
requestBody:
required: false
content:
@@ -65892,9 +65444,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
requestBody:
required: false
content:
@@ -65948,9 +65500,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'200':
description: Response
@@ -66087,8 +65639,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -66106,9 +65658,9 @@ paths:
type: integer
secrets:
type: array
- items: *490
+ items: *487
examples:
- default: *491
+ default: *488
headers:
Link: *47
x-github:
@@ -66133,16 +65685,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *492
+ schema: *489
examples:
- default: *493
+ default: *490
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66164,17 +65716,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'200':
description: Response
content:
application/json:
- schema: *490
+ schema: *487
examples:
- default: &631
+ default: &628
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -66200,8 +65752,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
requestBody:
required: true
@@ -66259,8 +65811,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'204':
@@ -66286,9 +65838,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables
parameters:
- - *459
- - *460
- - *477
+ - *456
+ - *457
+ - *474
- *19
responses:
'200':
@@ -66305,9 +65857,9 @@ paths:
type: integer
variables:
type: array
- items: *494
+ items: *491
examples:
- default: *495
+ default: *492
headers:
Link: *47
x-github:
@@ -66330,8 +65882,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -66383,17 +65935,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
responses:
'200':
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: &632
+ default: &629
value:
name: USERNAME
value: octocat
@@ -66419,8 +65971,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
requestBody:
required: true
@@ -66463,8 +66015,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
responses:
'204':
@@ -66490,8 +66042,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -66509,7 +66061,7 @@ paths:
type: integer
workflows:
type: array
- items: &496
+ items: &493
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -66616,9 +66168,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow
parameters:
- - *459
- - *460
- - &497
+ - *456
+ - *457
+ - &494
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -66633,7 +66185,7 @@ paths:
description: Response
content:
application/json:
- schema: *496
+ schema: *493
examples:
default:
value:
@@ -66666,9 +66218,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow
parameters:
- - *459
- - *460
- - *497
+ - *456
+ - *457
+ - *494
responses:
'204':
description: Response
@@ -66693,9 +66245,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *459
- - *460
- - *497
+ - *456
+ - *457
+ - *494
responses:
'204':
description: Response
@@ -66746,9 +66298,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow
parameters:
- - *459
- - *460
- - *497
+ - *456
+ - *457
+ - *494
responses:
'204':
description: Response
@@ -66775,19 +66327,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:
- - *459
- - *460
+ - *456
+ - *457
+ - *494
+ - *495
+ - *496
- *497
- *498
+ - *17
+ - *19
- *499
+ - *478
- *500
- *501
- - *17
- - *19
- - *502
- - *481
- - *503
- - *504
responses:
'200':
description: Response
@@ -66803,9 +66355,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *482
+ items: *479
examples:
- default: *505
+ default: *502
headers:
Link: *47
x-github:
@@ -66838,9 +66390,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage
parameters:
- - *459
- - *460
- - *497
+ - *456
+ - *457
+ - *494
responses:
'200':
description: Response
@@ -66901,8 +66453,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *110
- *17
- *108
@@ -67066,8 +66618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -67104,8 +66656,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:
- - *459
- - *460
+ - *456
+ - *457
- name: assignee
in: path
required: true
@@ -67141,8 +66693,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -67254,8 +66806,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *108
- *109
@@ -67312,7 +66864,7 @@ paths:
initiator:
type: string
examples:
- default: *506
+ default: *503
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67332,8 +66884,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -67341,7 +66893,7 @@ paths:
application/json:
schema:
type: array
- items: &507
+ items: &504
title: Autolink reference
description: An autolink reference.
type: object
@@ -67395,8 +66947,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -67435,9 +66987,9 @@ paths:
description: response
content:
application/json:
- schema: *507
+ schema: *504
examples:
- default: &508
+ default: &505
value:
id: 1
key_prefix: TICKET-
@@ -67468,9 +67020,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:
- - *459
- - *460
- - &509
+ - *456
+ - *457
+ - &506
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -67482,9 +67034,9 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
- default: *508
+ default: *505
'404': *6
x-github:
githubCloudOnly: false
@@ -67504,9 +67056,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:
- - *459
- - *460
- - *509
+ - *456
+ - *457
+ - *506
responses:
'204':
description: Response
@@ -67530,8 +67082,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response if Dependabot is enabled
@@ -67579,8 +67131,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -67601,8 +67153,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -67622,8 +67174,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -67661,7 +67213,7 @@ paths:
- url
protected:
type: boolean
- protection: &511
+ protection: &508
title: Branch Protection
description: Branch Protection
type: object
@@ -67703,7 +67255,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &514
+ enforce_admins: &511
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -67718,7 +67270,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &516
+ required_pull_request_reviews: &513
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -67794,7 +67346,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &513
+ restrictions: &510
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -68071,9 +67623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch
parameters:
- - *459
- - *460
- - &512
+ - *456
+ - *457
+ - &509
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).
@@ -68087,14 +67639,14 @@ paths:
description: Response
content:
application/json:
- schema: &522
+ schema: &519
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &576
+ commit: &573
title: Commit
description: Commit
type: object
@@ -68128,7 +67680,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &510
+ properties: &507
name:
type: string
example: '"Chris Wanstrath"'
@@ -68144,7 +67696,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *510
+ properties: *507
nullable: true
message:
type: string
@@ -68165,7 +67717,7 @@ paths:
required:
- sha
- url
- verification: &638
+ verification: &635
title: Verification
type: object
properties:
@@ -68235,7 +67787,7 @@ paths:
type: integer
files:
type: array
- items: &589
+ items: &586
title: Diff Entry
description: Diff Entry
type: object
@@ -68319,7 +67871,7 @@ paths:
- self
protected:
type: boolean
- protection: *511
+ protection: *508
protection_url:
type: string
format: uri
@@ -68426,7 +67978,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *465
+ '301': *462
'404': *6
x-github:
githubCloudOnly: false
@@ -68448,15 +68000,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
default:
value:
@@ -68650,9 +68202,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -68907,7 +68459,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &519
+ required_status_checks: &516
title: Status Check Policy
description: Status Check Policy
type: object
@@ -69059,7 +68611,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *513
+ restrictions: *510
required_conversation_resolution:
type: object
properties:
@@ -69171,9 +68723,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69198,17 +68750,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &515
+ default: &512
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -69230,17 +68782,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *515
+ default: *512
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -69259,9 +68811,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69286,17 +68838,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *516
+ schema: *513
examples:
- default: &517
+ default: &514
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -69392,9 +68944,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -69492,9 +69044,9 @@ paths:
description: Response
content:
application/json:
- schema: *516
+ schema: *513
examples:
- default: *517
+ default: *514
'422': *15
x-github:
githubCloudOnly: false
@@ -69515,9 +69067,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69544,17 +69096,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &518
+ default: &515
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -69577,17 +69129,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *518
+ default: *515
'404': *6
x-github:
githubCloudOnly: false
@@ -69607,9 +69159,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69634,17 +69186,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: &520
+ default: &517
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -69670,9 +69222,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -69724,9 +69276,9 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: *520
+ default: *517
'404': *6
'422': *15
x-github:
@@ -69748,9 +69300,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69774,9 +69326,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
@@ -69810,9 +69362,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -69879,9 +69431,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -69945,9 +69497,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
content:
application/json:
@@ -70013,15 +69565,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *513
+ schema: *510
examples:
default:
value:
@@ -70112,9 +69664,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -70137,9 +69689,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:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
@@ -70149,7 +69701,7 @@ paths:
type: array
items: *5
examples:
- default: &521
+ default: &518
value:
- id: 1
slug: octoapp
@@ -70206,9 +69758,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70242,7 +69794,7 @@ paths:
type: array
items: *5
examples:
- default: *521
+ default: *518
'422': *15
x-github:
githubCloudOnly: false
@@ -70263,9 +69815,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70299,7 +69851,7 @@ paths:
type: array
items: *5
examples:
- default: *521
+ default: *518
'422': *15
x-github:
githubCloudOnly: false
@@ -70320,9 +69872,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70356,7 +69908,7 @@ paths:
type: array
items: *5
examples:
- default: *521
+ default: *518
'422': *15
x-github:
githubCloudOnly: false
@@ -70378,9 +69930,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:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
@@ -70410,9 +69962,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -70471,9 +70023,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -70532,9 +70084,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
content:
application/json:
@@ -70593,9 +70145,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:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
@@ -70629,9 +70181,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70689,9 +70241,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70749,9 +70301,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70811,9 +70363,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70835,7 +70387,7 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
default:
value:
@@ -70949,8 +70501,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *103
- *104
- *105
@@ -70986,8 +70538,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: bypass_request_number
in: path
required: true
@@ -71060,8 +70612,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *103
- *104
- *105
@@ -71101,8 +70653,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: bypass_request_number
in: path
required: true
@@ -71172,8 +70724,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: bypass_request_number
in: path
required: true
@@ -71244,8 +70796,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: bypass_response_id
in: path
required: true
@@ -71278,8 +70830,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -71558,7 +71110,7 @@ paths:
description: Response
content:
application/json:
- schema: &523
+ schema: &520
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -71678,7 +71230,7 @@ paths:
check.
type: array
items: *226
- deployment: &862
+ deployment: &857
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -71958,9 +71510,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run
parameters:
- - *459
- - *460
- - &524
+ - *456
+ - *457
+ - &521
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -71972,9 +71524,9 @@ paths:
description: Response
content:
application/json:
- schema: *523
+ schema: *520
examples:
- default: &525
+ default: &522
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -72074,9 +71626,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run
parameters:
- - *459
- - *460
- - *524
+ - *456
+ - *457
+ - *521
requestBody:
required: true
content:
@@ -72316,9 +71868,9 @@ paths:
description: Response
content:
application/json:
- schema: *523
+ schema: *520
examples:
- default: *525
+ default: *522
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72338,9 +71890,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations
parameters:
- - *459
- - *460
- - *524
+ - *456
+ - *457
+ - *521
- *17
- *19
responses:
@@ -72435,9 +71987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run
parameters:
- - *459
- - *460
- - *524
+ - *456
+ - *457
+ - *521
responses:
'201':
description: Response
@@ -72481,8 +72033,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -72504,7 +72056,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &528
+ schema: &525
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -72590,12 +72142,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &893
+ head_commit: &888
title: Simple Commit
description: A commit.
type: object
- properties: *526
- required: *527
+ properties: *523
+ required: *524
latest_check_runs_count:
type: integer
check_runs_url:
@@ -72623,7 +72175,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &529
+ default: &526
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -72914,9 +72466,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: *529
+ default: *526
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72935,8 +72487,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -73245,9 +72797,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite
parameters:
- - *459
- - *460
- - &530
+ - *456
+ - *457
+ - &527
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -73259,9 +72811,9 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: *529
+ default: *526
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73284,17 +72836,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:
- - *459
- - *460
- - *530
- - &582
+ - *456
+ - *457
+ - *527
+ - &579
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &583
+ - &580
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -73333,9 +72885,9 @@ paths:
type: integer
check_runs:
type: array
- items: *523
+ items: *520
examples:
- default: &584
+ default: &581
value:
total_count: 1
check_runs:
@@ -73437,9 +72989,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite
parameters:
- - *459
- - *460
- - *530
+ - *456
+ - *457
+ - *527
responses:
'201':
description: Response
@@ -73472,21 +73024,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:
- - *459
- - *460
+ - *456
+ - *457
- *317
- *318
- *19
- *17
- - &546
+ - &543
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: *531
- - &547
+ schema: *528
+ - &544
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -73517,7 +73069,7 @@ paths:
be returned.
in: query
required: false
- schema: *532
+ schema: *529
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -73541,7 +73093,7 @@ paths:
updated_at: *136
url: *133
html_url: *134
- instances_url: *533
+ instances_url: *530
state: *113
fixed_at: *138
dismissed_by:
@@ -73552,11 +73104,11 @@ paths:
required: *21
nullable: true
dismissed_at: *137
- dismissed_reason: *534
- dismissed_comment: *535
- rule: *536
- tool: *537
- most_recent_instance: *538
+ dismissed_reason: *531
+ dismissed_comment: *532
+ rule: *533
+ tool: *534
+ most_recent_instance: *535
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -73682,7 +73234,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &539
+ '403': &536
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -73709,9 +73261,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:
- - *459
- - *460
- - &540
+ - *456
+ - *457
+ - &537
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -73725,7 +73277,7 @@ paths:
description: Response
content:
application/json:
- schema: &541
+ schema: &538
type: object
properties:
number: *128
@@ -73733,7 +73285,7 @@ paths:
updated_at: *136
url: *133
html_url: *134
- instances_url: *533
+ instances_url: *530
state: *113
fixed_at: *138
dismissed_by:
@@ -73744,8 +73296,8 @@ paths:
required: *21
nullable: true
dismissed_at: *137
- dismissed_reason: *534
- dismissed_comment: *535
+ dismissed_reason: *531
+ dismissed_comment: *532
rule:
type: object
properties:
@@ -73799,8 +73351,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *537
- most_recent_instance: *538
+ tool: *534
+ most_recent_instance: *535
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -73899,7 +73451,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -73919,9 +73471,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
requestBody:
required: true
content:
@@ -73936,8 +73488,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *534
- dismissed_comment: *535
+ dismissed_reason: *531
+ dismissed_comment: *532
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -73965,7 +73517,7 @@ paths:
description: Response
content:
application/json:
- schema: *541
+ schema: *538
examples:
default:
value:
@@ -74041,7 +73593,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &545
+ '403': &542
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -74068,15 +73620,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
responses:
'200':
description: Response
content:
application/json:
- schema: &542
+ schema: &539
type: object
properties:
status:
@@ -74102,13 +73654,13 @@ paths:
- description
- started_at
examples:
- default: &543
+ default: &540
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &544
+ '400': &541
description: Bad Request
content:
application/json:
@@ -74119,7 +73671,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': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -74144,29 +73696,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
responses:
'200':
description: OK
content:
application/json:
- schema: *542
+ schema: *539
examples:
- default: *543
+ default: *540
'202':
description: Accepted
content:
application/json:
- schema: *542
+ schema: *539
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *544
+ '400': *541
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -74198,9 +73750,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
requestBody:
required: false
content:
@@ -74245,8 +73797,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *544
- '403': *545
+ '400': *541
+ '403': *542
'404': *6
'422':
description: Unprocessable Entity
@@ -74270,13 +73822,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
- *19
- *17
- - *546
- - *547
+ - *543
+ - *544
responses:
'200':
description: Response
@@ -74287,10 +73839,10 @@ paths:
items:
type: object
properties:
- ref: *531
- analysis_key: *548
- environment: *549
- category: *550
+ ref: *528
+ analysis_key: *545
+ environment: *546
+ category: *547
state:
type: string
description: State of a code scanning alert instance.
@@ -74305,7 +73857,7 @@ paths:
properties:
text:
type: string
- location: *551
+ location: *548
html_url:
type: string
classifications:
@@ -74313,7 +73865,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: *552
+ items: *549
examples:
default:
value:
@@ -74352,7 +73904,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -74386,25 +73938,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:
- - *459
- - *460
+ - *456
+ - *457
- *317
- *318
- *19
- *17
- - *547
+ - *544
- 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: *531
+ schema: *528
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &553
+ schema: &550
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -74425,23 +73977,23 @@ paths:
application/json:
schema:
type: array
- items: &554
+ items: &551
type: object
properties:
- ref: *531
- commit_sha: &562
+ ref: *528
+ commit_sha: &559
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: *548
+ analysis_key: *545
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *550
+ category: *547
error:
type: string
example: error reading field xyz
@@ -74465,8 +74017,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *553
- tool: *537
+ sarif_id: *550
+ tool: *534
deletable:
type: boolean
warning:
@@ -74527,7 +74079,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -74563,8 +74115,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:
- - *459
- - *460
+ - *456
+ - *457
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -74577,7 +74129,7 @@ paths:
description: Response
content:
application/json:
- schema: *554
+ schema: *551
examples:
response:
summary: application/json response
@@ -74631,7 +74183,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *539
+ '403': *536
'404': *6
'422':
description: Response if analysis could not be processed
@@ -74718,8 +74270,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:
- - *459
- - *460
+ - *456
+ - *457
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -74772,7 +74324,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': *545
+ '403': *542
'404': *6
'503': *196
x-github:
@@ -74794,8 +74346,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -74803,7 +74355,7 @@ paths:
application/json:
schema:
type: array
- items: &555
+ items: &552
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -74914,7 +74466,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': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -74943,8 +74495,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:
- - *459
- - *460
+ - *456
+ - *457
- name: language
in: path
description: The language of the CodeQL database.
@@ -74956,7 +74508,7 @@ paths:
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
default:
value:
@@ -74988,9 +74540,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': &591
+ '302': &588
description: Found
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -75012,8 +74564,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: language
in: path
description: The language of the CodeQL database.
@@ -75023,7 +74575,7 @@ paths:
responses:
'204':
description: Response
- '403': *545
+ '403': *542
'404': *6
'503': *196
x-github:
@@ -75051,8 +74603,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -75061,7 +74613,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &556
+ language: &553
type: string
description: The language targeted by the CodeQL query
enum:
@@ -75141,7 +74693,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &560
+ schema: &557
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -75151,7 +74703,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *120
actor: *4
- query_language: *556
+ query_language: *553
query_pack_url:
type: string
description: The download url for the query pack.
@@ -75198,7 +74750,7 @@ paths:
items:
type: object
properties:
- repository: &557
+ repository: &554
title: Repository Identifier
description: Repository Identifier
type: object
@@ -75234,7 +74786,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &561
+ analysis_status: &558
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -75266,7 +74818,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &558
+ access_mismatch_repos: &555
type: object
properties:
repository_count:
@@ -75280,7 +74832,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: *557
+ items: *554
required:
- repository_count
- repositories
@@ -75302,8 +74854,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *558
- over_limit_repos: *558
+ no_codeql_db_repos: *555
+ over_limit_repos: *555
required:
- access_mismatch_repos
- not_found_repos
@@ -75319,7 +74871,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &559
+ value: &556
summary: Default response
value:
id: 1
@@ -75465,10 +75017,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *559
+ value: *556
repository_lists:
summary: Response for a successful variant analysis submission
- value: *559
+ value: *556
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -75496,8 +75048,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:
- - *459
- - *460
+ - *456
+ - *457
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -75509,9 +75061,9 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: *559
+ default: *556
'404': *6
'503': *196
x-github:
@@ -75534,7 +75086,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:
- - *459
+ - *456
- name: repo
in: path
description: The name of the controller repository.
@@ -75569,7 +75121,7 @@ paths:
type: object
properties:
repository: *120
- analysis_status: *561
+ analysis_status: *558
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -75694,8 +75246,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -75780,7 +75332,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -75801,8 +75353,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -75894,7 +75446,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *545
+ '403': *542
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -75965,8 +75517,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -75974,7 +75526,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *562
+ commit_sha: *559
ref:
type: string
description: |-
@@ -76032,7 +75584,7 @@ paths:
schema:
type: object
properties:
- id: *553
+ id: *550
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -76046,7 +75598,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': *545
+ '403': *542
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -76069,8 +75621,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:
- - *459
- - *460
+ - *456
+ - *457
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -76116,7 +75668,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': *539
+ '403': *536
'404':
description: Not Found if the sarif id does not match any upload
'503': *196
@@ -76141,8 +75693,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -76223,8 +75775,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors
parameters:
- - *459
- - *460
+ - *456
+ - *457
- 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
@@ -76344,8 +75896,8 @@ paths:
parameters:
- *17
- *19
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -76659,8 +76211,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -76725,7 +76277,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -76733,7 +76285,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'400': *14
'401': *25
'403': *29
@@ -76762,8 +76314,8 @@ paths:
parameters:
- *17
- *19
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -76827,8 +76379,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:
- - *459
- - *460
+ - *456
+ - *457
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -76863,14 +76415,14 @@ paths:
type: integer
machines:
type: array
- items: &809
+ items: &804
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *564
- required: *565
+ properties: *561
+ required: *562
examples:
- default: &810
+ default: &805
value:
total_count: 2
machines:
@@ -76910,8 +76462,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -76995,8 +76547,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:
- - *459
- - *460
+ - *456
+ - *457
- 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
@@ -77062,8 +76614,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -77081,7 +76633,7 @@ paths:
type: integer
secrets:
type: array
- items: &569
+ items: &566
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -77101,7 +76653,7 @@ paths:
- created_at
- updated_at
examples:
- default: *566
+ default: *563
headers:
Link: *47
x-github:
@@ -77124,16 +76676,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: *568
+ default: *565
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -77153,17 +76705,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'200':
description: Response
content:
application/json:
- schema: *569
+ schema: *566
examples:
- default: *570
+ default: *567
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -77183,8 +76735,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:
- - *459
- - *460
+ - *456
+ - *457
- *294
requestBody:
required: true
@@ -77237,8 +76789,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'204':
@@ -77267,8 +76819,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -77310,7 +76862,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &571
+ properties: &568
login:
type: string
example: octocat
@@ -77403,7 +76955,7 @@ paths:
user_view_type:
type: string
example: public
- required: &572
+ required: &569
- avatar_url
- events_url
- followers_url
@@ -77477,8 +77029,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:
- - *459
- - *460
+ - *456
+ - *457
- *143
responses:
'204':
@@ -77525,8 +77077,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *143
requestBody:
required: false
@@ -77553,7 +77105,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &651
+ schema: &648
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -77782,8 +77334,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *143
responses:
'204':
@@ -77815,8 +77367,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *143
responses:
'200':
@@ -77837,8 +77389,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *571
- required: *572
+ properties: *568
+ required: *569
nullable: true
required:
- permission
@@ -77893,8 +77445,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -77904,7 +77456,7 @@ paths:
application/json:
schema:
type: array
- items: &573
+ items: &570
title: Commit Comment
description: Commit Comment
type: object
@@ -77962,7 +77514,7 @@ paths:
- created_at
- updated_at
examples:
- default: &578
+ default: &575
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78021,17 +77573,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'200':
description: Response
content:
application/json:
- schema: *573
+ schema: *570
examples:
- default: &579
+ default: &576
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78088,8 +77640,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -78112,7 +77664,7 @@ paths:
description: Response
content:
application/json:
- schema: *573
+ schema: *570
examples:
default:
value:
@@ -78163,8 +77715,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'204':
@@ -78186,8 +77738,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -78214,7 +77766,7 @@ paths:
application/json:
schema:
type: array
- items: &574
+ items: &571
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -78257,7 +77809,7 @@ paths:
- content
- created_at
examples:
- default: &655
+ default: &652
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -78302,8 +77854,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -78336,9 +77888,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: &575
+ default: &572
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -78367,9 +77919,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -78391,10 +77943,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- - &656
+ - &653
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -78449,8 +78001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -78506,9 +78058,9 @@ paths:
application/json:
schema:
type: array
- items: *576
+ items: *573
examples:
- default: &705
+ default: &702
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -78602,9 +78154,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit
parameters:
- - *459
- - *460
- - &577
+ - *456
+ - *457
+ - &574
name: commit_sha
description: The SHA of the commit.
in: path
@@ -78676,9 +78228,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments
parameters:
- - *459
- - *460
- - *577
+ - *456
+ - *457
+ - *574
- *17
- *19
responses:
@@ -78688,9 +78240,9 @@ paths:
application/json:
schema:
type: array
- items: *573
+ items: *570
examples:
- default: *578
+ default: *575
headers:
Link: *47
x-github:
@@ -78718,9 +78270,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment
parameters:
- - *459
- - *460
- - *577
+ - *456
+ - *457
+ - *574
requestBody:
required: true
content:
@@ -78755,9 +78307,9 @@ paths:
description: Response
content:
application/json:
- schema: *573
+ schema: *570
examples:
- default: *579
+ default: *576
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78785,9 +78337,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:
- - *459
- - *460
- - *577
+ - *456
+ - *457
+ - *574
- *17
- *19
responses:
@@ -78797,9 +78349,9 @@ paths:
application/json:
schema:
type: array
- items: *580
+ items: *577
examples:
- default: &697
+ default: &694
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -79336,11 +78888,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *19
- *17
- - &581
+ - &578
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)"
@@ -79355,9 +78907,9 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: &682
+ default: &679
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -79470,11 +79022,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:
- - *459
- - *460
- - *581
- - *582
- - *583
+ - *456
+ - *457
+ - *578
+ - *579
+ - *580
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -79508,9 +79060,9 @@ paths:
type: integer
check_runs:
type: array
- items: *523
+ items: *520
examples:
- default: *584
+ default: *581
headers:
Link: *47
x-github:
@@ -79535,9 +79087,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:
- - *459
- - *460
- - *581
+ - *456
+ - *457
+ - *578
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -79545,7 +79097,7 @@ paths:
schema:
type: integer
example: 1
- - *582
+ - *579
- *17
- *19
responses:
@@ -79563,7 +79115,7 @@ paths:
type: integer
check_suites:
type: array
- items: *528
+ items: *525
examples:
default:
value:
@@ -79763,9 +79315,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:
- - *459
- - *460
- - *581
+ - *456
+ - *457
+ - *578
- *17
- *19
responses:
@@ -79963,9 +79515,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *459
- - *460
- - *581
+ - *456
+ - *457
+ - *578
- *17
- *19
responses:
@@ -79975,7 +79527,7 @@ paths:
application/json:
schema:
type: array
- items: &758
+ items: &755
title: Status
description: The status of a commit.
type: object
@@ -80056,7 +79608,7 @@ paths:
site_admin: false
headers:
Link: *47
- '301': *465
+ '301': *462
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80084,8 +79636,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -80114,20 +79666,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *585
- required: *586
+ properties: *582
+ required: *583
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &587
+ properties: &584
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &588
+ required: &585
- url
- html_url
nullable: true
@@ -80141,26 +79693,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *587
- required: *588
+ properties: *584
+ required: *585
nullable: true
readme:
title: Community Health File
type: object
- properties: *587
- required: *588
+ properties: *584
+ required: *585
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *587
- required: *588
+ properties: *584
+ required: *585
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *587
- required: *588
+ properties: *584
+ required: *585
nullable: true
required:
- code_of_conduct
@@ -80287,8 +79839,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *19
- *17
- name: basehead
@@ -80331,8 +79883,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *576
- merge_base_commit: *576
+ base_commit: *573
+ merge_base_commit: *573
status:
type: string
enum:
@@ -80352,10 +79904,10 @@ paths:
example: 6
commits:
type: array
- items: *576
+ items: *573
files:
type: array
- items: *589
+ items: *586
required:
- url
- html_url
@@ -80641,8 +80193,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: path
description: path parameter
in: path
@@ -80785,7 +80337,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &590
+ response-if-content-is-a-file: &587
summary: Response if content is a file
value:
type: file
@@ -80917,7 +80469,7 @@ paths:
- size
- type
- url
- - &710
+ - &707
title: Content File
description: Content File
type: object
@@ -81118,7 +80670,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *590
+ response-if-content-is-a-file: *587
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -81187,7 +80739,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *591
+ '302': *588
'304': *37
x-github:
githubCloudOnly: false
@@ -81210,8 +80762,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: path
description: path parameter
in: path
@@ -81304,7 +80856,7 @@ paths:
description: Response
content:
application/json:
- schema: &592
+ schema: &589
title: File Commit
description: File Commit
type: object
@@ -81456,7 +81008,7 @@ paths:
description: Response
content:
application/json:
- schema: *592
+ schema: *589
examples:
example-for-creating-a-file:
value:
@@ -81510,7 +81062,7 @@ paths:
schema:
oneOf:
- *3
- - &633
+ - &630
description: Repository rule violation was detected
type: object
properties:
@@ -81531,7 +81083,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &750
+ placeholder_id: &747
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -81563,8 +81115,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: path
description: path parameter
in: path
@@ -81625,7 +81177,7 @@ paths:
description: Response
content:
application/json:
- schema: *592
+ schema: *589
examples:
default:
value:
@@ -81680,8 +81232,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -81804,8 +81356,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *332
- *333
- *334
@@ -81817,7 +81369,7 @@ paths:
schema:
type: string
- *336
- - *593
+ - *590
- *337
- *338
- *110
@@ -81838,7 +81390,7 @@ paths:
application/json:
schema:
type: array
- items: &597
+ items: &594
type: object
description: A Dependabot alert.
properties:
@@ -81884,7 +81436,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *594
+ security_advisory: *591
security_vulnerability: *132
url: *133
html_url: *134
@@ -81915,8 +81467,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *138
- auto_dismissed_at: *595
- dismissal_request: *596
+ auto_dismissed_at: *592
+ dismissal_request: *593
required:
- number
- state
@@ -82146,9 +81698,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *459
- - *460
- - &598
+ - *456
+ - *457
+ - &595
name: alert_number
in: path
description: |-
@@ -82163,7 +81715,7 @@ paths:
description: Response
content:
application/json:
- schema: *597
+ schema: *594
examples:
default:
value:
@@ -82276,9 +81828,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *459
- - *460
- - *598
+ - *456
+ - *457
+ - *595
requestBody:
required: true
content:
@@ -82323,7 +81875,7 @@ paths:
description: Response
content:
application/json:
- schema: *597
+ schema: *594
examples:
default:
value:
@@ -82452,8 +82004,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -82471,7 +82023,7 @@ paths:
type: integer
secrets:
type: array
- items: &601
+ items: &598
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -82524,16 +82076,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *599
+ schema: *596
examples:
- default: *600
+ default: *597
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82553,15 +82105,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'200':
description: Response
content:
application/json:
- schema: *601
+ schema: *598
examples:
default:
value:
@@ -82587,8 +82139,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
requestBody:
required: true
@@ -82641,8 +82193,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'204':
@@ -82665,8 +82217,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:
- - *459
- - *460
+ - *456
+ - *457
- 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
@@ -82826,8 +82378,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -83066,8 +82618,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -83142,7 +82694,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &602
+ metadata: &599
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -83175,7 +82727,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *602
+ metadata: *599
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -83188,7 +82740,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *602
+ metadata: *599
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -83317,8 +82869,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -83358,9 +82910,9 @@ paths:
application/json:
schema:
type: array
- items: *603
+ items: *600
examples:
- default: *604
+ default: *601
headers:
Link: *47
x-github:
@@ -83426,8 +82978,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -83508,7 +83060,7 @@ paths:
description: Response
content:
application/json:
- schema: *603
+ schema: *600
examples:
simple-example:
summary: Simple example
@@ -83581,9 +83133,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment
parameters:
- - *459
- - *460
- - &605
+ - *456
+ - *457
+ - &602
name: deployment_id
description: deployment_id parameter
in: path
@@ -83595,7 +83147,7 @@ paths:
description: Response
content:
application/json:
- schema: *603
+ schema: *600
examples:
default:
value:
@@ -83660,9 +83212,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment
parameters:
- - *459
- - *460
- - *605
+ - *456
+ - *457
+ - *602
responses:
'204':
description: Response
@@ -83684,9 +83236,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses
parameters:
- - *459
- - *460
- - *605
+ - *456
+ - *457
+ - *602
- *17
- *19
responses:
@@ -83696,7 +83248,7 @@ paths:
application/json:
schema:
type: array
- items: &606
+ items: &603
title: Deployment Status
description: The status of a deployment.
type: object
@@ -83857,9 +83409,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status
parameters:
- - *459
- - *460
- - *605
+ - *456
+ - *457
+ - *602
requestBody:
required: true
content:
@@ -83934,9 +83486,9 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *603
examples:
- default: &607
+ default: &604
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -83992,9 +83544,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status
parameters:
- - *459
- - *460
- - *605
+ - *456
+ - *457
+ - *602
- name: status_id
in: path
required: true
@@ -84005,9 +83557,9 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *603
examples:
- default: *607
+ default: *604
'404': *6
x-github:
githubCloudOnly: false
@@ -84034,12 +83586,12 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
+ - *605
+ - *606
+ - *607
- *608
- - *609
- - *610
- - *611
- *17
- *19
responses:
@@ -84049,9 +83601,9 @@ paths:
application/json:
schema:
type: array
- items: *612
+ items: *609
examples:
- default: *613
+ default: *610
'404': *6
'403': *29
'500': *40
@@ -84075,8 +83627,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84088,7 +83640,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *612
+ schema: *609
examples:
default:
value:
@@ -84144,8 +83696,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84204,12 +83756,12 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
+ - *605
+ - *606
+ - *607
- *608
- - *609
- - *610
- - *611
- *17
- *19
responses:
@@ -84219,9 +83771,9 @@ paths:
application/json:
schema:
type: array
- items: *614
+ items: *611
examples:
- default: *615
+ default: *612
'404': *6
'403': *29
'500': *40
@@ -84245,8 +83797,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84258,7 +83810,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *614
+ schema: *611
examples:
default:
value:
@@ -84309,8 +83861,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84348,7 +83900,7 @@ paths:
description: The created dismissal request.
content:
application/json:
- schema: *614
+ schema: *611
examples:
default:
value:
@@ -84399,8 +83951,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84471,8 +84023,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84505,8 +84057,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *103
- *104
- *105
@@ -84520,9 +84072,9 @@ paths:
application/json:
schema:
type: array
- items: *616
+ items: *613
examples:
- default: *617
+ default: *614
'404': *6
'403': *29
'500': *40
@@ -84547,8 +84099,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84560,7 +84112,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *616
+ schema: *613
examples:
default:
value:
@@ -84618,8 +84170,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84688,8 +84240,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -84746,8 +84298,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -84764,7 +84316,7 @@ paths:
type: integer
environments:
type: array
- items: &619
+ items: &616
title: Environment
description: Details of a deployment environment
type: object
@@ -84816,7 +84368,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &621
+ wait_timer: &618
type: integer
example: 30
description: The amount of time to delay a job after
@@ -84853,7 +84405,7 @@ paths:
items:
type: object
properties:
- type: *618
+ type: *615
reviewer:
anyOf:
- *4
@@ -84877,7 +84429,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &622
+ deployment_branch_policy: &619
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -84993,9 +84545,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment
parameters:
- - *459
- - *460
- - &620
+ - *456
+ - *457
+ - &617
name: environment_name
in: path
required: true
@@ -85008,9 +84560,9 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: &623
+ default: &620
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -85094,9 +84646,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
requestBody:
required: false
content:
@@ -85105,7 +84657,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *621
+ wait_timer: *618
prevent_self_review:
type: boolean
example: false
@@ -85122,13 +84674,13 @@ paths:
items:
type: object
properties:
- type: *618
+ type: *615
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *622
+ deployment_branch_policy: *619
additionalProperties: false
examples:
default:
@@ -85148,9 +84700,9 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: *623
+ default: *620
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -85174,9 +84726,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
responses:
'204':
description: Default response
@@ -85201,9 +84753,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *17
- *19
responses:
@@ -85221,7 +84773,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &624
+ items: &621
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -85278,9 +84830,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
requestBody:
required: true
content:
@@ -85326,9 +84878,9 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
- example-wildcard: &625
+ example-wildcard: &622
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -85370,10 +84922,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *459
- - *460
- - *620
- - &626
+ - *456
+ - *457
+ - *617
+ - &623
name: branch_policy_id
in: path
required: true
@@ -85385,9 +84937,9 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
- default: *625
+ default: *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85406,10 +84958,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *459
- - *460
- - *620
- - *626
+ - *456
+ - *457
+ - *617
+ - *623
requestBody:
required: true
content:
@@ -85437,9 +84989,9 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
- default: *625
+ default: *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85458,10 +85010,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *459
- - *460
- - *620
- - *626
+ - *456
+ - *457
+ - *617
+ - *623
responses:
'204':
description: Response
@@ -85486,9 +85038,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:
- - *620
- - *460
- - *459
+ - *617
+ - *457
+ - *456
responses:
'200':
description: List of deployment protection rules
@@ -85504,7 +85056,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &627
+ items: &624
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -85523,7 +85075,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &628
+ app: &625
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -85622,9 +85174,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:
- - *620
- - *460
- - *459
+ - *617
+ - *457
+ - *456
requestBody:
content:
application/json:
@@ -85645,9 +85197,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: &629
+ default: &626
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -85682,9 +85234,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:
- - *620
- - *460
- - *459
+ - *617
+ - *457
+ - *456
- *19
- *17
responses:
@@ -85703,7 +85255,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *628
+ items: *625
examples:
default:
value:
@@ -85738,10 +85290,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:
- - *459
- - *460
- - *620
- - &630
+ - *456
+ - *457
+ - *617
+ - &627
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -85753,9 +85305,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: *629
+ default: *626
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85776,10 +85328,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:
- - *620
- - *460
- - *459
- - *630
+ - *617
+ - *457
+ - *456
+ - *627
responses:
'204':
description: Response
@@ -85805,9 +85357,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *17
- *19
responses:
@@ -85825,9 +85377,9 @@ paths:
type: integer
secrets:
type: array
- items: *490
+ items: *487
examples:
- default: *491
+ default: *488
headers:
Link: *47
x-github:
@@ -85852,17 +85404,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
responses:
'200':
description: Response
content:
application/json:
- schema: *492
+ schema: *489
examples:
- default: *493
+ default: *490
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85884,18 +85436,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *294
responses:
'200':
description: Response
content:
application/json:
- schema: *490
+ schema: *487
examples:
- default: *631
+ default: *628
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85917,9 +85469,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *294
requestBody:
required: true
@@ -85977,9 +85529,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *294
responses:
'204':
@@ -86005,10 +85557,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables
parameters:
- - *459
- - *460
- - *620
- - *477
+ - *456
+ - *457
+ - *617
+ - *474
- *19
responses:
'200':
@@ -86025,9 +85577,9 @@ paths:
type: integer
variables:
type: array
- items: *494
+ items: *491
examples:
- default: *495
+ default: *492
headers:
Link: *47
x-github:
@@ -86050,9 +85602,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
requestBody:
required: true
content:
@@ -86104,18 +85656,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *297
responses:
'200':
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: *632
+ default: *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86136,10 +85688,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
- - *620
+ - *617
requestBody:
required: true
content:
@@ -86181,10 +85733,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
- - *620
+ - *617
responses:
'204':
description: Response
@@ -86206,8 +85758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -86275,8 +85827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -86435,8 +85987,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -86468,9 +86020,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
+ default: *463
'400': *14
'422': *15
'403': *29
@@ -86491,8 +86043,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -86552,7 +86104,7 @@ paths:
schema:
oneOf:
- *259
- - *633
+ - *630
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86577,8 +86129,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: file_sha
in: path
required: true
@@ -86677,8 +86229,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -86787,7 +86339,7 @@ paths:
description: Response
content:
application/json:
- schema: &634
+ schema: &631
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -87001,15 +86553,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object
parameters:
- - *459
- - *460
- - *577
+ - *456
+ - *457
+ - *574
responses:
'200':
description: Response
content:
application/json:
- schema: *634
+ schema: *631
examples:
default:
value:
@@ -87065,9 +86617,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references
parameters:
- - *459
- - *460
- - &635
+ - *456
+ - *457
+ - &632
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.
@@ -87084,7 +86636,7 @@ paths:
application/json:
schema:
type: array
- items: &636
+ items: &633
title: Git Reference
description: Git references within a repository
type: object
@@ -87159,17 +86711,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference
parameters:
- - *459
- - *460
- - *635
+ - *456
+ - *457
+ - *632
responses:
'200':
description: Response
content:
application/json:
- schema: *636
+ schema: *633
examples:
- default: &637
+ default: &634
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -87198,8 +86750,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -87228,9 +86780,9 @@ paths:
description: Response
content:
application/json:
- schema: *636
+ schema: *633
examples:
- default: *637
+ default: *634
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -87256,9 +86808,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference
parameters:
- - *459
- - *460
- - *635
+ - *456
+ - *457
+ - *632
requestBody:
required: true
content:
@@ -87287,9 +86839,9 @@ paths:
description: Response
content:
application/json:
- schema: *636
+ schema: *633
examples:
- default: *637
+ default: *634
'422': *15
'409': *119
x-github:
@@ -87307,9 +86859,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference
parameters:
- - *459
- - *460
- - *635
+ - *456
+ - *457
+ - *632
responses:
'204':
description: Response
@@ -87364,8 +86916,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -87432,7 +86984,7 @@ paths:
description: Response
content:
application/json:
- schema: &639
+ schema: &636
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -87483,7 +87035,7 @@ paths:
- sha
- type
- url
- verification: *638
+ verification: *635
required:
- sha
- url
@@ -87493,7 +87045,7 @@ paths:
- tag
- message
examples:
- default: &640
+ default: &637
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -87566,8 +87118,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: tag_sha
in: path
required: true
@@ -87578,9 +87130,9 @@ paths:
description: Response
content:
application/json:
- schema: *639
+ schema: *636
examples:
- default: *640
+ default: *637
'404': *6
'409': *119
x-github:
@@ -87604,8 +87156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -87678,7 +87230,7 @@ paths:
description: Response
content:
application/json:
- schema: &641
+ schema: &638
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -87774,8 +87326,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -87798,7 +87350,7 @@ paths:
description: Response
content:
application/json:
- schema: *641
+ schema: *638
examples:
default-response:
summary: Default response
@@ -87857,8 +87409,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -87868,7 +87420,7 @@ paths:
application/json:
schema:
type: array
- items: &642
+ items: &639
title: Webhook
description: Webhooks for repositories.
type: object
@@ -87922,7 +87474,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &901
+ last_response: &896
title: Hook Response
type: object
properties:
@@ -87996,8 +87548,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -88049,9 +87601,9 @@ paths:
description: Response
content:
application/json:
- schema: *642
+ schema: *639
examples:
- default: &643
+ default: &640
value:
type: Repository
id: 12345678
@@ -88099,17 +87651,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'200':
description: Response
content:
application/json:
- schema: *642
+ schema: *639
examples:
- default: *643
+ default: *640
'404': *6
x-github:
githubCloudOnly: false
@@ -88129,8 +87681,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
requestBody:
required: true
@@ -88176,9 +87728,9 @@ paths:
description: Response
content:
application/json:
- schema: *642
+ schema: *639
examples:
- default: *643
+ default: *640
'422': *15
'404': *6
x-github:
@@ -88199,8 +87751,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'204':
@@ -88225,8 +87777,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:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'200':
@@ -88254,8 +87806,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:
- - *459
- - *460
+ - *456
+ - *457
- *348
requestBody:
required: false
@@ -88300,8 +87852,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
- *17
- *349
@@ -88333,8 +87885,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:
- - *459
- - *460
+ - *456
+ - *457
- *348
- *16
responses:
@@ -88363,8 +87915,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:
- - *459
- - *460
+ - *456
+ - *457
- *348
- *16
responses:
@@ -88388,8 +87940,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'204':
@@ -88415,8 +87967,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'204':
@@ -88440,8 +87992,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response if immutable releases are enabled
@@ -88487,8 +88039,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204': *155
'409': *119
@@ -88508,8 +88060,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204': *155
'409': *119
@@ -88566,14 +88118,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &644
+ schema: &641
title: Import
description: A repository import from an external source.
type: object
@@ -88672,7 +88224,7 @@ paths:
- html_url
- authors_url
examples:
- default: &647
+ default: &644
value:
vcs: subversion
use_lfs: true
@@ -88688,7 +88240,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': &645
+ '503': &642
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -88717,8 +88269,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -88766,7 +88318,7 @@ paths:
description: Response
content:
application/json:
- schema: *644
+ schema: *641
examples:
default:
value:
@@ -88791,7 +88343,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88819,8 +88371,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -88869,7 +88421,7 @@ paths:
description: Response
content:
application/json:
- schema: *644
+ schema: *641
examples:
example-1:
summary: Example 1
@@ -88917,7 +88469,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': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88940,12 +88492,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88971,9 +88523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors
parameters:
- - *459
- - *460
- - &831
+ - *456
+ - *457
+ - &826
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -88987,7 +88539,7 @@ paths:
application/json:
schema:
type: array
- items: &646
+ items: &643
title: Porter Author
description: Porter Author
type: object
@@ -89041,7 +88593,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': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89066,8 +88618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: author_id
in: path
required: true
@@ -89097,7 +88649,7 @@ paths:
description: Response
content:
application/json:
- schema: *646
+ schema: *643
examples:
default:
value:
@@ -89110,7 +88662,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89134,8 +88686,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -89176,7 +88728,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89204,8 +88756,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -89232,11 +88784,11 @@ paths:
description: Response
content:
application/json:
- schema: *644
+ schema: *641
examples:
- default: *647
+ default: *644
'422': *15
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89259,8 +88811,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -89268,8 +88820,8 @@ paths:
application/json:
schema: *22
examples:
- default: *648
- '301': *465
+ default: *645
+ '301': *462
'404': *6
x-github:
githubCloudOnly: false
@@ -89289,8 +88841,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -89303,7 +88855,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &650
+ default: &647
value:
limit: collaborators_only
origin: repository
@@ -89328,13 +88880,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
application/json:
- schema: *649
+ schema: *646
examples:
default:
summary: Example request body
@@ -89348,7 +88900,7 @@ paths:
application/json:
schema: *366
examples:
- default: *650
+ default: *647
'409':
description: Response
x-github:
@@ -89370,8 +88922,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -89394,8 +88946,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -89405,9 +88957,9 @@ paths:
application/json:
schema:
type: array
- items: *651
+ items: *648
examples:
- default: &824
+ default: &819
value:
- id: 1
repository:
@@ -89538,8 +89090,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *370
requestBody:
required: false
@@ -89569,7 +89121,7 @@ paths:
description: Response
content:
application/json:
- schema: *651
+ schema: *648
examples:
default:
value:
@@ -89700,8 +89252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *370
responses:
'204':
@@ -89733,8 +89285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues
parameters:
- - *459
- - *460
+ - *456
+ - *457
- 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
@@ -89807,7 +89359,7 @@ paths:
type: array
items: *221
examples:
- default: &663
+ default: &660
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -89955,7 +89507,7 @@ paths:
state_reason: completed
headers:
Link: *47
- '301': *465
+ '301': *462
'422': *15
'404': *6
x-github:
@@ -89984,8 +89536,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -90069,7 +89621,7 @@ paths:
application/json:
schema: *221
examples:
- default: &660
+ default: &657
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -90225,7 +89777,7 @@ paths:
'422': *15
'503': *196
'404': *6
- '410': *652
+ '410': *649
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -90253,8 +89805,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *245
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -90275,9 +89827,9 @@ paths:
application/json:
schema:
type: array
- items: *653
+ items: *650
examples:
- default: &662
+ default: &659
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -90335,17 +89887,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'200':
description: Response
content:
application/json:
- schema: *653
+ schema: *650
examples:
- default: &654
+ default: &651
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -90399,8 +89951,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -90423,9 +89975,9 @@ paths:
description: Response
content:
application/json:
- schema: *653
+ schema: *650
examples:
- default: *654
+ default: *651
'422': *15
x-github:
githubCloudOnly: false
@@ -90443,8 +89995,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'204':
@@ -90465,8 +90017,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -90493,9 +90045,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *655
+ default: *652
headers:
Link: *47
'404': *6
@@ -90516,8 +90068,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -90550,16 +90102,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'201':
description: Reaction created
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -90581,10 +90133,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- - *656
+ - *653
responses:
'204':
description: Response
@@ -90604,8 +90156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -90615,7 +90167,7 @@ paths:
application/json:
schema:
type: array
- items: &659
+ items: &656
title: Issue Event
description: Issue Event
type: object
@@ -90658,8 +90210,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *657
- required: *658
+ properties: *654
+ required: *655
nullable: true
label:
title: Issue Event Label
@@ -90966,8 +90518,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: event_id
in: path
required: true
@@ -90978,7 +90530,7 @@ paths:
description: Response
content:
application/json:
- schema: *659
+ schema: *656
examples:
default:
value:
@@ -91170,7 +90722,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *652
+ '410': *649
'403': *29
x-github:
githubCloudOnly: false
@@ -91204,9 +90756,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue
parameters:
- - *459
- - *460
- - &661
+ - *456
+ - *457
+ - &658
name: issue_number
description: The number that identifies the issue.
in: path
@@ -91220,10 +90772,10 @@ paths:
application/json:
schema: *221
examples:
- default: *660
- '301': *465
+ default: *657
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
'304': *37
x-github:
githubCloudOnly: false
@@ -91248,9 +90800,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -91356,13 +90908,13 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
'422': *15
'503': *196
'403': *29
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91380,9 +90932,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -91410,7 +90962,7 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91426,9 +90978,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
content:
application/json:
@@ -91455,7 +91007,7 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91477,9 +91029,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- name: assignee
in: path
required: true
@@ -91519,9 +91071,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *228
- *17
- *19
@@ -91532,13 +91084,13 @@ paths:
application/json:
schema:
type: array
- items: *653
+ items: *650
examples:
- default: *662
+ default: *659
headers:
Link: *47
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91567,9 +91119,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -91591,16 +91143,16 @@ paths:
description: Response
content:
application/json:
- schema: *653
+ schema: *650
examples:
- default: *654
+ default: *651
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *652
+ '410': *649
'422': *15
'404': *6
x-github:
@@ -91628,9 +91180,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -91642,12 +91194,12 @@ paths:
type: array
items: *221
examples:
- default: *663
+ default: *660
headers:
Link: *47
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91675,9 +91227,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -91701,15 +91253,15 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *465
+ '301': *462
'403': *29
- '410': *652
+ '410': *649
'422': *15
'404': *6
x-github:
@@ -91740,9 +91292,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -91756,13 +91308,13 @@ paths:
application/json:
schema: *221
examples:
- default: *660
- '301': *465
+ default: *657
+ '301': *462
'400': *14
'401': *25
'403': *29
'404': *6
- '410': *652
+ '410': *649
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -91788,9 +91340,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -91802,12 +91354,12 @@ paths:
type: array
items: *221
examples:
- default: *663
+ default: *660
headers:
Link: *47
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91824,9 +91376,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -91840,7 +91392,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &665
+ - &662
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -91894,7 +91446,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &666
+ - &663
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -92030,7 +91582,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &667
+ - &664
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -92081,7 +91633,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &668
+ - &665
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -92132,7 +91684,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &669
+ - &666
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -92186,7 +91738,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &670
+ - &667
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -92233,7 +91785,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &671
+ - &668
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -92280,7 +91832,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &672
+ - &669
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -92340,7 +91892,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &673
+ - &670
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -92388,7 +91940,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &674
+ - &671
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -92454,7 +92006,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &675
+ - &672
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -92520,7 +92072,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &676
+ - &673
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -92586,7 +92138,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &677
+ - &674
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -92677,7 +92229,7 @@ paths:
color: red
headers:
Link: *47
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92694,9 +92246,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -92708,7 +92260,7 @@ paths:
type: array
items: *220
examples:
- default: &664
+ default: &661
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -92726,9 +92278,9 @@ paths:
default: false
headers:
Link: *47
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92745,9 +92297,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -92808,10 +92360,10 @@ paths:
type: array
items: *220
examples:
- default: *664
- '301': *465
+ default: *661
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
'422': *15
x-github:
githubCloudOnly: false
@@ -92828,9 +92380,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -92892,10 +92444,10 @@ paths:
type: array
items: *220
examples:
- default: *664
- '301': *465
+ default: *661
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
'422': *15
x-github:
githubCloudOnly: false
@@ -92912,15 +92464,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
responses:
'204':
description: Response
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92939,9 +92491,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- name: name
in: path
required: true
@@ -92965,9 +92517,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92987,9 +92539,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -93017,7 +92569,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *652
+ '410': *649
'404': *6
'422': *15
x-github:
@@ -93035,9 +92587,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
responses:
'204':
description: Response
@@ -93067,9 +92619,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
responses:
'200':
description: Response
@@ -93077,10 +92629,10 @@ paths:
application/json:
schema: *221
examples:
- default: *660
- '301': *465
+ default: *657
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93097,9 +92649,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -93125,13 +92677,13 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *655
+ default: *652
headers:
Link: *47
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93149,9 +92701,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -93183,16 +92735,16 @@ paths:
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'201':
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -93214,10 +92766,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *459
- - *460
- - *661
- - *656
+ - *456
+ - *457
+ - *658
+ - *653
responses:
'204':
description: Response
@@ -93246,9 +92798,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -93272,7 +92824,7 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -93305,9 +92857,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -93319,11 +92871,11 @@ paths:
type: array
items: *221
examples:
- default: *663
+ default: *660
headers:
Link: *47
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93351,9 +92903,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -93382,14 +92934,14 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *652
+ '410': *649
'422': *15
'404': *6
x-github:
@@ -93409,9 +92961,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -93444,7 +92996,7 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
'403': *29
'404': *6
'422': *7
@@ -93466,9 +93018,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -93483,6 +93035,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *662
+ - *663
+ - *664
- *665
- *666
- *667
@@ -93493,9 +93048,6 @@ paths:
- *672
- *673
- *674
- - *675
- - *676
- - *677
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -93804,7 +93356,7 @@ paths:
type: string
comments:
type: array
- items: &699
+ items: &696
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -94019,7 +93571,7 @@ paths:
type: string
comments:
type: array
- items: *573
+ items: *570
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -94308,7 +93860,7 @@ paths:
headers:
Link: *47
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94325,8 +93877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -94336,7 +93888,7 @@ paths:
application/json:
schema:
type: array
- items: &678
+ items: &675
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -94402,8 +93954,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -94439,9 +93991,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *675
examples:
- default: &679
+ default: &676
value:
id: 1
key: ssh-rsa AAA...
@@ -94475,9 +94027,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *459
- - *460
- - &680
+ - *456
+ - *457
+ - &677
name: key_id
description: The unique identifier of the key.
in: path
@@ -94489,9 +94041,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *675
examples:
- default: *679
+ default: *676
'404': *6
x-github:
githubCloudOnly: false
@@ -94509,9 +94061,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *459
- - *460
- - *680
+ - *456
+ - *457
+ - *677
responses:
'204':
description: Response
@@ -94531,8 +94083,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -94544,7 +94096,7 @@ paths:
type: array
items: *220
examples:
- default: *664
+ default: *661
headers:
Link: *47
'404': *6
@@ -94565,8 +94117,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -94604,7 +94156,7 @@ paths:
application/json:
schema: *220
examples:
- default: &681
+ default: &678
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -94636,8 +94188,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: name
in: path
required: true
@@ -94650,7 +94202,7 @@ paths:
application/json:
schema: *220
examples:
- default: *681
+ default: *678
'404': *6
x-github:
githubCloudOnly: false
@@ -94667,8 +94219,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: name
in: path
required: true
@@ -94733,8 +94285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: name
in: path
required: true
@@ -94760,8 +94312,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -94797,8 +94349,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'202': *39
'403':
@@ -94826,8 +94378,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -94853,9 +94405,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *459
- - *460
- - *546
+ - *456
+ - *457
+ - *543
responses:
'200':
description: Response
@@ -95000,8 +94552,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95066,8 +94618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95101,9 +94653,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *682
+ default: *679
'204':
description: Response when already merged
'404':
@@ -95128,8 +94680,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -95170,7 +94722,7 @@ paths:
application/json:
schema:
type: array
- items: &683
+ items: &680
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -95231,8 +94783,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95272,9 +94824,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: &684
+ default: &681
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -95333,9 +94885,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone
parameters:
- - *459
- - *460
- - &685
+ - *456
+ - *457
+ - &682
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -95347,9 +94899,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: *684
+ default: *681
'404': *6
x-github:
githubCloudOnly: false
@@ -95366,9 +94918,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone
parameters:
- - *459
- - *460
- - *685
+ - *456
+ - *457
+ - *682
requestBody:
required: false
content:
@@ -95406,9 +94958,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: *684
+ default: *681
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95424,9 +94976,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone
parameters:
- - *459
- - *460
- - *685
+ - *456
+ - *457
+ - *682
responses:
'204':
description: Response
@@ -95447,9 +94999,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *459
- - *460
- - *685
+ - *456
+ - *457
+ - *682
- *17
- *19
responses:
@@ -95461,7 +95013,7 @@ paths:
type: array
items: *220
examples:
- default: *664
+ default: *661
headers:
Link: *47
x-github:
@@ -95480,12 +95032,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *459
- - *460
- - *686
- - *687
+ - *456
+ - *457
+ - *683
+ - *684
- *228
- - *688
+ - *685
- *17
- *19
responses:
@@ -95497,7 +95049,7 @@ paths:
type: array
items: *248
examples:
- default: *689
+ default: *686
headers:
Link: *47
x-github:
@@ -95521,8 +95073,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -95580,14 +95132,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &690
+ schema: &687
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -95712,7 +95264,7 @@ paths:
- custom_404
- public
examples:
- default: &691
+ default: &688
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -95753,8 +95305,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95808,9 +95360,9 @@ paths:
description: Response
content:
application/json:
- schema: *690
+ schema: *687
examples:
- default: *691
+ default: *688
'422': *15
'409': *119
x-github:
@@ -95833,8 +95385,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95941,8 +95493,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -95968,8 +95520,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -95979,7 +95531,7 @@ paths:
application/json:
schema:
type: array
- items: &692
+ items: &689
title: Page Build
description: Page Build
type: object
@@ -96073,8 +95625,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'201':
description: Response
@@ -96119,16 +95671,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *692
+ schema: *689
examples:
- default: &693
+ default: &690
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -96176,8 +95728,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: build_id
in: path
required: true
@@ -96188,9 +95740,9 @@ paths:
description: Response
content:
application/json:
- schema: *692
+ schema: *689
examples:
- default: *693
+ default: *690
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -96210,8 +95762,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -96316,9 +95868,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *459
- - *460
- - &694
+ - *456
+ - *457
+ - &691
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -96376,9 +95928,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *459
- - *460
- - *694
+ - *456
+ - *457
+ - *691
responses:
'204': *155
'404': *6
@@ -96405,8 +95957,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -96664,8 +96216,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Private vulnerability reporting status
@@ -96702,8 +96254,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204': *155
'422': *14
@@ -96724,8 +96276,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204': *155
'422': *14
@@ -96747,8 +96299,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -96758,7 +96310,7 @@ paths:
type: array
items: *156
examples:
- default: *695
+ default: *692
'403': *29
'404': *6
x-github:
@@ -96780,8 +96332,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -96797,7 +96349,7 @@ paths:
required:
- properties
examples:
- default: *696
+ default: *693
responses:
'204':
description: No Content when custom property values are successfully created
@@ -96835,8 +96387,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -96896,9 +96448,9 @@ paths:
application/json:
schema:
type: array
- items: *580
+ items: *577
examples:
- default: *697
+ default: *694
headers:
Link: *47
'304': *37
@@ -96930,8 +96482,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -96996,7 +96548,7 @@ paths:
description: Response
content:
application/json:
- schema: &701
+ schema: &698
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -97210,7 +96762,7 @@ paths:
- review_comment
- self
author_association: *222
- auto_merge: *698
+ auto_merge: *695
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -97302,7 +96854,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &702
+ default: &699
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -97829,8 +97381,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sort
in: query
required: false
@@ -97859,9 +97411,9 @@ paths:
application/json:
schema:
type: array
- items: *699
+ items: *696
examples:
- default: &704
+ default: &701
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -97938,17 +97490,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'200':
description: Response
content:
application/json:
- schema: *699
+ schema: *696
examples:
- default: &700
+ default: &697
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -98023,8 +97575,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:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -98047,9 +97599,9 @@ paths:
description: Response
content:
application/json:
- schema: *699
+ schema: *696
examples:
- default: *700
+ default: *697
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -98065,8 +97617,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:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'204':
@@ -98088,8 +97640,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:
- - *459
- - *460
+ - *456
+ - *457
- *237
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -98116,9 +97668,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *655
+ default: *652
headers:
Link: *47
'404': *6
@@ -98139,8 +97691,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:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -98173,16 +97725,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'201':
description: Reaction created
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -98204,10 +97756,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- - *656
+ - *653
responses:
'204':
description: Response
@@ -98250,9 +97802,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request
parameters:
- - *459
- - *460
- - &703
+ - *456
+ - *457
+ - &700
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -98265,9 +97817,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *701
+ schema: *698
examples:
- default: *702
+ default: *699
'304': *37
'404': *6
'406':
@@ -98302,9 +97854,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -98346,9 +97898,9 @@ paths:
description: Response
content:
application/json:
- schema: *701
+ schema: *698
examples:
- default: *702
+ default: *699
'422': *15
'403': *29
x-github:
@@ -98370,9 +97922,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: true
content:
@@ -98434,7 +97986,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -98442,7 +97994,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'401': *25
'403': *29
'404': *6
@@ -98472,9 +98024,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *245
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -98495,9 +98047,9 @@ paths:
application/json:
schema:
type: array
- items: *699
+ items: *696
examples:
- default: *704
+ default: *701
headers:
Link: *47
x-github:
@@ -98530,9 +98082,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: true
content:
@@ -98637,7 +98189,7 @@ paths:
description: Response
content:
application/json:
- schema: *699
+ schema: *696
examples:
example-for-a-multi-line-comment:
value:
@@ -98725,9 +98277,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *237
requestBody:
required: true
@@ -98750,7 +98302,7 @@ paths:
description: Response
content:
application/json:
- schema: *699
+ schema: *696
examples:
default:
value:
@@ -98836,9 +98388,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *17
- *19
responses:
@@ -98848,9 +98400,9 @@ paths:
application/json:
schema:
type: array
- items: *576
+ items: *573
examples:
- default: *705
+ default: *702
headers:
Link: *47
x-github:
@@ -98880,9 +98432,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *17
- *19
responses:
@@ -98892,7 +98444,7 @@ paths:
application/json:
schema:
type: array
- items: *589
+ items: *586
examples:
default:
value:
@@ -98930,9 +98482,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
responses:
'204':
description: Response if pull request has been merged
@@ -98955,9 +98507,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -99068,9 +98620,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
responses:
'200':
description: Response
@@ -99145,9 +98697,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -99184,7 +98736,7 @@ paths:
description: Response
content:
application/json:
- schema: *580
+ schema: *577
examples:
default:
value:
@@ -99720,9 +99272,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: true
content:
@@ -99756,7 +99308,7 @@ paths:
description: Response
content:
application/json:
- schema: *580
+ schema: *577
examples:
default:
value:
@@ -100261,9 +99813,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *17
- *19
responses:
@@ -100273,7 +99825,7 @@ paths:
application/json:
schema:
type: array
- items: &706
+ items: &703
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -100424,9 +99976,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -100512,9 +100064,9 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
- default: &708
+ default: &705
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -100577,10 +100129,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - &707
+ - *456
+ - *457
+ - *700
+ - &704
name: review_id
description: The unique identifier of the review.
in: path
@@ -100592,9 +100144,9 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
- default: &709
+ default: &706
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -100653,10 +100205,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
requestBody:
required: true
content:
@@ -100679,7 +100231,7 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
default:
value:
@@ -100741,18 +100293,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
responses:
'200':
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
- default: *708
+ default: *705
'422': *7
'404': *6
x-github:
@@ -100779,10 +100331,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
- *17
- *19
responses:
@@ -101017,10 +100569,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
requestBody:
required: true
content:
@@ -101048,7 +100600,7 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
default:
value:
@@ -101111,10 +100663,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
requestBody:
required: true
content:
@@ -101149,9 +100701,9 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
- default: *709
+ default: *706
'404': *6
'422': *7
'403': *29
@@ -101173,9 +100725,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -101238,8 +100790,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -101252,9 +100804,9 @@ paths:
description: Response
content:
application/json:
- schema: *710
+ schema: *707
examples:
- default: &711
+ default: &708
value:
type: file
encoding: base64
@@ -101296,8 +100848,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:
- - *459
- - *460
+ - *456
+ - *457
- name: dir
description: The alternate path to look for a README file
in: path
@@ -101317,9 +100869,9 @@ paths:
description: Response
content:
application/json:
- schema: *710
+ schema: *707
examples:
- default: *711
+ default: *708
'404': *6
'422': *15
x-github:
@@ -101341,8 +100893,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -101352,7 +100904,7 @@ paths:
application/json:
schema:
type: array
- items: *712
+ items: *709
examples:
default:
value:
@@ -101446,8 +100998,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -101523,9 +101075,9 @@ paths:
description: Response
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: &716
+ default: &713
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -101630,9 +101182,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset
parameters:
- - *459
- - *460
- - &714
+ - *456
+ - *457
+ - &711
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -101644,9 +101196,9 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
- default: &715
+ default: &712
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1
browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip
@@ -101681,7 +101233,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *591
+ '302': *588
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -101697,9 +101249,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset
parameters:
- - *459
- - *460
- - *714
+ - *456
+ - *457
+ - *711
requestBody:
required: false
content:
@@ -101727,9 +101279,9 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
- default: *715
+ default: *712
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -101745,9 +101297,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset
parameters:
- - *459
- - *460
- - *714
+ - *456
+ - *457
+ - *711
responses:
'204':
description: Response
@@ -101771,8 +101323,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -101857,16 +101409,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: *716
+ default: *713
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -101883,8 +101435,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: tag
description: tag parameter
in: path
@@ -101897,9 +101449,9 @@ paths:
description: Response
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: *716
+ default: *713
'404': *6
x-github:
githubCloudOnly: false
@@ -101921,9 +101473,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release
parameters:
- - *459
- - *460
- - &717
+ - *456
+ - *457
+ - &714
name: release_id
description: The unique identifier of the release.
in: path
@@ -101937,9 +101489,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: *716
+ default: *713
'401':
description: Unauthorized
x-github:
@@ -101957,9 +101509,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
requestBody:
required: false
content:
@@ -102023,9 +101575,9 @@ paths:
description: Response
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: *716
+ default: *713
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -102046,9 +101598,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
responses:
'204':
description: Response
@@ -102068,9 +101620,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
- *17
- *19
responses:
@@ -102080,7 +101632,7 @@ paths:
application/json:
schema:
type: array
- items: *713
+ items: *710
examples:
default:
value:
@@ -102162,9 +101714,9 @@ paths:
description: The URL origin (protocol + host name + port) is included in `upload_url`
returned in the response of the "Create a release" endpoint
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
- name: name
in: query
required: true
@@ -102190,7 +101742,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *713
+ schema: *710
examples:
response-for-successful-upload:
value:
@@ -102245,9 +101797,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -102271,9 +101823,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *655
+ default: *652
headers:
Link: *47
'404': *6
@@ -102294,9 +101846,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
requestBody:
required: true
content:
@@ -102326,16 +101878,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'201':
description: Reaction created
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -102357,10 +101909,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *459
- - *460
- - *717
- - *656
+ - *456
+ - *457
+ - *714
+ - *653
responses:
'204':
description: Response
@@ -102384,9 +101936,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
- *17
- *19
responses:
@@ -102403,7 +101955,7 @@ paths:
oneOf:
- allOf:
- *170
- - &718
+ - &715
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -102424,67 +101976,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *171
- - *718
+ - *715
- allOf:
- *172
- - *718
+ - *715
- allOf:
- *173
- - *718
+ - *715
- allOf:
- - *719
- - *718
+ - *716
+ - *715
- allOf:
- *174
- - *718
+ - *715
- allOf:
- *175
- - *718
+ - *715
- allOf:
- *176
- - *718
+ - *715
- allOf:
- *177
- - *718
+ - *715
- allOf:
- *178
- - *718
+ - *715
- allOf:
- *179
- - *718
+ - *715
- allOf:
- *180
- - *718
+ - *715
- allOf:
- *181
- - *718
+ - *715
- allOf:
- *182
- - *718
+ - *715
- allOf:
- *183
- - *718
+ - *715
- allOf:
- *184
- - *718
+ - *715
- allOf:
- *185
- - *718
+ - *715
- allOf:
- *186
- - *718
+ - *715
- allOf:
- *187
- - *718
+ - *715
- allOf:
- *188
- - *718
+ - *715
- allOf:
- *189
- - *718
+ - *715
- allOf:
- *190
- - *718
+ - *715
examples:
default:
value:
@@ -102523,8 +102075,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
- name: includes_parents
@@ -102535,7 +102087,7 @@ paths:
schema:
type: boolean
default: true
- - *720
+ - *717
responses:
'200':
description: Response
@@ -102590,8 +102142,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
description: Request body
required: true
@@ -102620,7 +102172,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *721
+ items: *718
required:
- name
- enforcement
@@ -102653,7 +102205,7 @@ paths:
application/json:
schema: *191
examples:
- default: &730
+ default: &727
value:
id: 42
name: super cool ruleset
@@ -102700,12 +102252,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *459
- - *460
- - *722
+ - *456
+ - *457
+ - *719
- *105
- - *723
- - *724
+ - *720
+ - *721
- *17
- *19
responses:
@@ -102713,9 +102265,9 @@ paths:
description: Response
content:
application/json:
- schema: *725
+ schema: *722
examples:
- default: *726
+ default: *723
'404': *6
'500': *40
x-github:
@@ -102736,17 +102288,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *459
- - *460
- - *727
+ - *456
+ - *457
+ - *724
responses:
'200':
description: Response
content:
application/json:
- schema: *728
+ schema: *725
examples:
- default: *729
+ default: *726
'404': *6
'500': *40
x-github:
@@ -102774,8 +102326,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -102797,7 +102349,7 @@ paths:
application/json:
schema: *191
examples:
- default: *730
+ default: *727
'404': *6
'500': *40
put:
@@ -102815,8 +102367,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -102850,7 +102402,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *721
+ items: *718
examples:
default:
value:
@@ -102880,7 +102432,7 @@ paths:
application/json:
schema: *191
examples:
- default: *730
+ default: *727
'404': *6
'500': *40
delete:
@@ -102898,8 +102450,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -102922,8 +102474,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
- name: ruleset_id
@@ -102960,8 +102512,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103034,8 +102586,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:
- - *459
- - *460
+ - *456
+ - *457
- *427
- *428
- *429
@@ -103044,8 +102596,8 @@ paths:
- *110
- *19
- *17
- - *731
- - *732
+ - *728
+ - *729
- *432
- *433
- *434
@@ -103057,7 +102609,7 @@ paths:
application/json:
schema:
type: array
- items: &736
+ items: &733
type: object
properties:
number: *128
@@ -103076,8 +102628,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *733
- resolution: *734
+ state: *730
+ resolution: *731
resolved_at:
type: string
format: date-time
@@ -103173,7 +102725,7 @@ paths:
pull request.
'
- oneOf: *735
+ oneOf: *732
nullable: true
has_more_locations:
type: boolean
@@ -103322,16 +102874,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
- *435
responses:
'200':
description: Response
content:
application/json:
- schema: *736
+ schema: *733
examples:
default:
value:
@@ -103385,9 +102937,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
requestBody:
required: true
content:
@@ -103395,8 +102947,8 @@ paths:
schema:
type: object
properties:
- state: *733
- resolution: *734
+ state: *730
+ resolution: *731
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -103430,7 +102982,7 @@ paths:
description: Response
content:
application/json:
- schema: *736
+ schema: *733
examples:
default:
value:
@@ -103525,9 +103077,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
- *19
- *17
responses:
@@ -103538,7 +103090,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &923
+ items: &918
type: object
properties:
type:
@@ -103564,6 +103116,9 @@ paths:
example: commit
details:
oneOf:
+ - *734
+ - *735
+ - *736
- *737
- *738
- *739
@@ -103574,9 +103129,6 @@ paths:
- *744
- *745
- *746
- - *747
- - *748
- - *749
examples:
default:
value:
@@ -103662,8 +103214,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -103671,14 +103223,14 @@ paths:
schema:
type: object
properties:
- reason: &751
+ reason: &748
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *750
+ placeholder_id: *747
required:
- reason
- placeholder_id
@@ -103695,7 +103247,7 @@ paths:
schema:
type: object
properties:
- reason: *751
+ reason: *748
expire_at:
type: string
format: date-time
@@ -103741,8 +103293,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -103757,7 +103309,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &752
+ items: &749
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -103783,15 +103335,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *752
+ items: *749
backfill_scans:
type: array
- items: *752
+ items: *749
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *752
+ - *749
- type: object
properties:
pattern_name:
@@ -103861,8 +103413,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *110
- name: sort
description: The property to sort the results by.
@@ -103906,9 +103458,9 @@ paths:
application/json:
schema:
type: array
- items: *753
+ items: *750
examples:
- default: *754
+ default: *751
'400': *14
'404': *6
x-github:
@@ -103931,8 +103483,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -104092,9 +103644,9 @@ paths:
description: Response
content:
application/json:
- schema: *753
+ schema: *750
examples:
- default: &756
+ default: &753
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -104327,8 +103879,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -104432,7 +103984,7 @@ paths:
description: Response
content:
application/json:
- schema: *753
+ schema: *750
examples:
default:
value:
@@ -104579,17 +104131,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *459
- - *460
- - *755
+ - *456
+ - *457
+ - *752
responses:
'200':
description: Response
content:
application/json:
- schema: *753
+ schema: *750
examples:
- default: *756
+ default: *753
'403': *29
'404': *6
x-github:
@@ -104613,9 +104165,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *459
- - *460
- - *755
+ - *456
+ - *457
+ - *752
requestBody:
required: true
content:
@@ -104774,10 +104326,10 @@ paths:
description: Response
content:
application/json:
- schema: *753
+ schema: *750
examples:
- default: *756
- add_credit: *756
+ default: *753
+ add_credit: *753
'403': *29
'404': *6
'422':
@@ -104815,9 +104367,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- - *459
- - *460
- - *755
+ - *456
+ - *457
+ - *752
responses:
'202': *39
'400': *14
@@ -104844,17 +104396,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:
- - *459
- - *460
- - *755
+ - *456
+ - *457
+ - *752
responses:
'202':
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
+ default: *463
'400': *14
'422': *15
'403': *29
@@ -104880,8 +104432,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -104980,8 +104532,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -104990,7 +104542,7 @@ paths:
application/json:
schema:
type: array
- items: &757
+ items: &754
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -105023,8 +104575,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -105100,8 +104652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -105197,8 +104749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -105352,8 +104904,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -105363,7 +104915,7 @@ paths:
application/json:
schema:
type: array
- items: *757
+ items: *754
examples:
default:
value:
@@ -105396,8 +104948,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sha
in: path
required: true
@@ -105451,7 +105003,7 @@ paths:
description: Response
content:
application/json:
- schema: *758
+ schema: *755
examples:
default:
value:
@@ -105505,8 +105057,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -105538,14 +105090,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &759
+ schema: &756
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -105613,8 +105165,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -105640,7 +105192,7 @@ paths:
description: Response
content:
application/json:
- schema: *759
+ schema: *756
examples:
default:
value:
@@ -105667,8 +105219,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -105688,8 +105240,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -105768,8 +105320,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -105777,7 +105329,7 @@ paths:
application/json:
schema:
type: array
- items: &760
+ items: &757
title: Tag protection
description: Tag protection
type: object
@@ -105829,8 +105381,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -105853,7 +105405,7 @@ paths:
description: Response
content:
application/json:
- schema: *760
+ schema: *757
examples:
default:
value:
@@ -105884,8 +105436,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:
- - *459
- - *460
+ - *456
+ - *457
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -105922,8 +105474,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ref
in: path
required: true
@@ -105959,8 +105511,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -105992,8 +105544,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *19
- *17
responses:
@@ -106001,7 +105553,7 @@ paths:
description: Response
content:
application/json:
- schema: &761
+ schema: &758
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -106013,7 +105565,7 @@ paths:
required:
- names
examples:
- default: &762
+ default: &759
value:
names:
- octocat
@@ -106036,8 +105588,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -106068,9 +105620,9 @@ paths:
description: Response
content:
application/json:
- schema: *761
+ schema: *758
examples:
- default: *762
+ default: *759
'404': *6
'422': *7
x-github:
@@ -106091,9 +105643,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones
parameters:
- - *459
- - *460
- - &763
+ - *456
+ - *457
+ - &760
name: per
description: The time frame to display results for.
in: query
@@ -106122,7 +105674,7 @@ paths:
example: 128
clones:
type: array
- items: &764
+ items: &761
title: Traffic
type: object
properties:
@@ -106209,8 +105761,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -106300,8 +105852,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -106361,9 +105913,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views
parameters:
- - *459
- - *460
- - *763
+ - *456
+ - *457
+ - *760
responses:
'200':
description: Response
@@ -106382,7 +105934,7 @@ paths:
example: 3782
views:
type: array
- items: *764
+ items: *761
required:
- uniques
- count
@@ -106459,8 +106011,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -106734,8 +106286,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -106758,8 +106310,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -106781,8 +106333,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -106808,8 +106360,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ref
in: path
required: true
@@ -106901,9 +106453,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
+ default: *463
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -107054,7 +106606,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &772
+ - &769
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -107063,7 +106615,7 @@ paths:
schema:
type: string
example: members
- - &777
+ - &774
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -107074,7 +106626,7 @@ paths:
default: 1
format: int32
example: 1
- - &778
+ - &775
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -107116,7 +106668,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &767
+ items: &764
allOf:
- type: object
required:
@@ -107191,7 +106743,7 @@ paths:
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
"$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
- meta: &779
+ meta: &776
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -107251,30 +106803,30 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &768
+ '400': &765
description: Bad request
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '401': *766
- '403': &769
+ schema: *762
+ '401': *763
+ '403': &766
description: Permission denied
- '429': &770
+ '429': &767
description: Too many requests
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '500': &771
+ schema: *762
+ '500': &768
description: Internal server error
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
+ schema: *762
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107298,7 +106850,7 @@ paths:
required: true
content:
application/json:
- schema: &775
+ schema: &772
type: object
required:
- schemas
@@ -107358,9 +106910,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *767
+ schema: *764
examples:
- group: &773
+ group: &770
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -107379,13 +106931,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
- '400': *768
- '401': *766
- '403': *769
- '409': &776
+ '400': *765
+ '401': *763
+ '403': *766
+ '409': &773
description: Duplicate record detected
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107402,7 +106954,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group
parameters:
- - &774
+ - &771
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -107410,22 +106962,22 @@ paths:
schema:
type: string
example: 7fce0092-d52e-4f76-b727-3955bd72c939
- - *772
+ - *769
- *41
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *767
+ schema: *764
examples:
- default: *773
- '400': *768
- '401': *766
- '403': *769
+ default: *770
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107444,13 +106996,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group
parameters:
- - *774
+ - *771
- *41
requestBody:
required: true
content:
application/json:
- schema: *775
+ schema: *772
examples:
group:
summary: Group
@@ -107476,17 +107028,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *767
+ schema: *764
examples:
- group: *773
- groupWithMembers: *773
- '400': *768
- '401': *766
- '403': *769
+ group: *770
+ groupWithMembers: *770
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '409': *776
- '429': *770
- '500': *771
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107510,13 +107062,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
parameters:
- - *774
+ - *771
- *41
requestBody:
required: true
content:
application/json:
- schema: &786
+ schema: &783
type: object
required:
- Operations
@@ -107576,17 +107128,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *767
+ schema: *764
examples:
- updateGroup: *773
- addMembers: *773
- '400': *768
- '401': *766
- '403': *769
+ updateGroup: *770
+ addMembers: *770
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '409': *776
- '429': *770
- '500': *771
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107602,17 +107154,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise
parameters:
- - *774
+ - *771
- *41
responses:
'204':
description: Group was deleted, no content
- '400': *768
- '401': *766
- '403': *769
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107646,8 +107198,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *777
- - *778
+ - *774
+ - *775
- *41
responses:
'200':
@@ -107680,7 +107232,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &781
+ items: &778
allOf:
- type: object
required:
@@ -107759,7 +107311,7 @@ paths:
description: Whether this email address is the primary
address.
example: true
- roles: &780
+ roles: &777
type: array
description: The roles assigned to the user.
items:
@@ -107815,7 +107367,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *779
+ meta: *776
startIndex:
type: integer
description: A starting index for the returned page
@@ -107852,11 +107404,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *768
- '401': *766
- '403': *769
- '429': *770
- '500': *771
+ '400': *765
+ '401': *763
+ '403': *766
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107880,7 +107432,7 @@ paths:
required: true
content:
application/json:
- schema: &784
+ schema: &781
type: object
required:
- schemas
@@ -107962,9 +107514,9 @@ paths:
type: boolean
description: Whether this email address is the primary address.
example: true
- roles: *780
+ roles: *777
examples:
- user: &785
+ user: &782
summary: User
value:
schemas:
@@ -108011,9 +107563,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *781
+ schema: *778
examples:
- user: &782
+ user: &779
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -108039,13 +107591,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939
- enterpriseOwner: *782
- '400': *768
- '401': *766
- '403': *769
- '409': *776
- '429': *770
- '500': *771
+ enterpriseOwner: *779
+ '400': *765
+ '401': *763
+ '403': *766
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108062,7 +107614,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user
parameters:
- - &783
+ - &780
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -108075,15 +107627,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *781
+ schema: *778
examples:
- default: *782
- '400': *768
- '401': *766
- '403': *769
+ default: *779
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108105,30 +107657,30 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user
parameters:
- - *783
+ - *780
- *41
requestBody:
required: true
content:
application/json:
- schema: *784
+ schema: *781
examples:
- user: *785
+ user: *782
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *781
+ schema: *778
examples:
- user: *782
- '400': *768
- '401': *766
- '403': *769
+ user: *779
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '409': *776
- '429': *770
- '500': *771
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108163,13 +107715,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
parameters:
- - *783
+ - *780
- *41
requestBody:
required: true
content:
application/json:
- schema: *786
+ schema: *783
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -108209,18 +107761,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *781
+ schema: *778
examples:
- userMultiValuedProperties: *782
- userSingleValuedProperties: *782
- disableUser: *782
- '400': *768
- '401': *766
- '403': *769
+ userMultiValuedProperties: *779
+ userSingleValuedProperties: *779
+ disableUser: *779
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '409': *776
- '429': *770
- '500': *771
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108240,17 +107792,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise
parameters:
- - *783
+ - *780
- *41
responses:
'204':
description: User was deleted, no content
- '400': *768
- '401': *766
- '403': *769
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108337,7 +107889,7 @@ paths:
example: 1
Resources:
type: array
- items: &787
+ items: &784
title: SCIM /Users
description: SCIM /Users provisioning endpoints
type: object
@@ -108568,22 +108120,22 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243
'304': *37
- '404': &788
+ '404': &785
description: Resource not found
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '403': &789
+ schema: *762
+ '403': &786
description: Forbidden
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '400': *768
- '429': *770
+ schema: *762
+ '400': *765
+ '429': *767
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -108609,9 +108161,9 @@ paths:
description: Response
content:
application/scim+json:
- schema: *787
+ schema: *784
examples:
- default: &790
+ default: &787
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -108634,17 +108186,17 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32
'304': *37
- '404': *788
- '403': *789
- '500': *771
+ '404': *785
+ '403': *786
+ '500': *768
'409':
description: Conflict
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '400': *768
+ schema: *762
+ '400': *765
requestBody:
required: true
content:
@@ -108742,17 +108294,17 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user
parameters:
- *87
- - *783
+ - *780
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *787
+ schema: *784
examples:
- default: *790
- '404': *788
- '403': *789
+ default: *787
+ '404': *785
+ '403': *786
'304': *37
x-github:
githubCloudOnly: true
@@ -108776,18 +108328,18 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership
parameters:
- *87
- - *783
+ - *780
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *787
+ schema: *784
examples:
- default: *790
+ default: *787
'304': *37
- '404': *788
- '403': *789
+ '404': *785
+ '403': *786
requestBody:
required: true
content:
@@ -108900,19 +108452,19 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user
parameters:
- *87
- - *783
+ - *780
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *787
+ schema: *784
examples:
- default: *790
+ default: *787
'304': *37
- '404': *788
- '403': *789
- '400': *768
+ '404': *785
+ '403': *786
+ '400': *765
'429':
description: Response
content:
@@ -109003,12 +108555,12 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization
parameters:
- *87
- - *783
+ - *780
responses:
'204':
description: Response
- '404': *788
- '403': *789
+ '404': *785
+ '403': *786
'304': *37
x-github:
githubCloudOnly: true
@@ -109141,7 +108693,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &791
+ text_matches: &788
title: Search Result Text Matches
type: array
items:
@@ -109304,7 +108856,7 @@ paths:
enum:
- author-date
- committer-date
- - &792
+ - &789
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
@@ -109375,7 +108927,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *510
+ properties: *507
nullable: true
comment_count:
type: integer
@@ -109395,7 +108947,7 @@ paths:
url:
type: string
format: uri
- verification: *638
+ verification: *635
required:
- author
- committer
@@ -109414,7 +108966,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *510
+ properties: *507
nullable: true
parents:
type: array
@@ -109432,7 +108984,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *791
+ text_matches: *788
required:
- sha
- node_id
@@ -109625,7 +109177,7 @@ paths:
- interactions
- created
- updated
- - *792
+ - *789
- *17
- *19
- name: advanced_search
@@ -109722,11 +109274,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
type: string
state_reason:
@@ -109758,7 +109310,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *791
+ text_matches: *788
pull_request:
type: object
properties:
@@ -109983,7 +109535,7 @@ paths:
enum:
- created
- updated
- - *792
+ - *789
- *17
- *19
responses:
@@ -110027,7 +109579,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *791
+ text_matches: *788
required:
- id
- node_id
@@ -110113,7 +109665,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *792
+ - *789
- *17
- *19
responses:
@@ -110352,7 +109904,7 @@ paths:
- admin
- pull
- push
- text_matches: *791
+ text_matches: *788
temp_clone_token:
type: string
allow_merge_commit:
@@ -110653,7 +110205,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *791
+ text_matches: *788
related:
type: array
nullable: true
@@ -110846,7 +110398,7 @@ paths:
- followers
- repositories
- joined
- - *792
+ - *789
- *17
- *19
responses:
@@ -110950,7 +110502,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *791
+ text_matches: *788
blog:
type: string
nullable: true
@@ -111029,7 +110581,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy
parameters:
- - &796
+ - &793
name: team_id
description: The unique identifier of the team.
in: path
@@ -111070,7 +110622,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy
parameters:
- - *796
+ - *793
requestBody:
required: true
content:
@@ -111170,7 +110722,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy
parameters:
- - *796
+ - *793
responses:
'204':
description: Response
@@ -111184,226 +110736,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy
- parameters:
- - *796
- - *110
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *451
- examples:
- default: *797
- headers:
- Link: *47
- 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]
- > **Endpoint closing down notice:** 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.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - *796
- 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: *451
- examples:
- default: *452
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - *796
- - *453
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *451
- examples:
- default: *452
- 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]
- > **Endpoint closing down notice:** 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.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth 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:
- - *796
- - *453
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *451
- examples:
- default: *798
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - *796
- - *453
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -111419,7 +110751,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *796
+ - *793
- *17
- *19
responses:
@@ -111457,7 +110789,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy
parameters:
- - *796
+ - *793
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -111508,7 +110840,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'204':
@@ -111545,7 +110877,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'204':
@@ -111585,7 +110917,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'204':
@@ -111622,16 +110954,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'200':
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- response-if-user-is-a-team-maintainer: *799
+ response-if-user-is-a-team-maintainer: *794
'404': *6
x-github:
githubCloudOnly: false
@@ -111664,7 +110996,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *796
+ - *793
- *143
requestBody:
required: false
@@ -111690,9 +111022,9 @@ paths:
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- response-if-users-membership-with-team-is-now-pending: *800
+ response-if-users-membership-with-team-is-now-pending: *795
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -111726,7 +111058,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'204':
@@ -111754,7 +111086,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy
parameters:
- - *796
+ - *793
- *17
- *19
responses:
@@ -111796,15 +111128,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *796
- - *459
- - *460
+ - *793
+ - *456
+ - *457
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *801
+ schema: *796
examples:
alternative-response-with-extra-repository-information:
value:
@@ -111955,9 +111287,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *796
- - *459
- - *460
+ - *793
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -112007,9 +111339,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *796
- - *459
- - *460
+ - *793
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -112038,15 +111370,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy
parameters:
- - *796
+ - *793
responses:
'200':
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: *462
+ default: *459
'403': *29
'404': *6
x-github:
@@ -112073,7 +111405,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy
parameters:
- - *796
+ - *793
requestBody:
required: true
content:
@@ -112130,7 +111462,7 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
default:
value:
@@ -112161,7 +111493,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy
parameters:
- - *796
+ - *793
- *17
- *19
responses:
@@ -112173,7 +111505,7 @@ paths:
type: array
items: *313
examples:
- response-if-child-teams-exist: *802
+ response-if-child-teams-exist: *797
headers:
Link: *47
'404': *6
@@ -112206,7 +111538,7 @@ paths:
application/json:
schema:
oneOf:
- - &804
+ - &799
title: Private User
description: Private User
type: object
@@ -112409,7 +111741,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *803
+ - *798
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -112562,7 +111894,7 @@ paths:
description: Response
content:
application/json:
- schema: *804
+ schema: *799
examples:
default:
value:
@@ -112908,7 +112240,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -112916,7 +112248,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'401': *25
'403': *29
'404': *6
@@ -112960,7 +112292,7 @@ paths:
type: integer
secrets:
type: array
- items: &805
+ items: &800
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -113000,7 +112332,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *566
+ default: *563
headers:
Link: *47
x-github:
@@ -113076,7 +112408,7 @@ paths:
description: Response
content:
application/json:
- schema: *805
+ schema: *800
examples:
default:
value:
@@ -113222,7 +112554,7 @@ paths:
type: array
items: *284
examples:
- default: *806
+ default: *801
'401': *25
'403': *29
'404': *6
@@ -113374,7 +112706,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'304': *37
'500': *40
'401': *25
@@ -113432,7 +112764,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'401': *25
'403': *29
'404': *6
@@ -113489,7 +112821,7 @@ paths:
description: Response
content:
application/json:
- schema: &807
+ schema: &802
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -113530,7 +112862,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &808
+ default: &803
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -113575,9 +112907,9 @@ paths:
description: Response
content:
application/json:
- schema: *807
+ schema: *802
examples:
- default: *808
+ default: *803
'404': *6
x-github:
githubCloudOnly: false
@@ -113614,9 +112946,9 @@ paths:
type: integer
machines:
type: array
- items: *809
+ items: *804
examples:
- default: *810
+ default: *805
'304': *37
'500': *40
'401': *25
@@ -113695,13 +113027,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *464
+ repository: *461
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *564
- required: *565
+ properties: *561
+ required: *562
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -114483,7 +113815,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'304': *37
'500': *40
'400': *14
@@ -114523,7 +113855,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'500': *40
'401': *25
'403': *29
@@ -114555,7 +113887,7 @@ paths:
type: array
items: *387
examples:
- default: &821
+ default: &816
value:
- id: 197
name: hello_docker
@@ -114656,7 +113988,7 @@ paths:
application/json:
schema:
type: array
- items: &811
+ items: &806
title: Email
description: Email
type: object
@@ -114721,9 +114053,9 @@ paths:
application/json:
schema:
type: array
- items: *811
+ items: *806
examples:
- default: &823
+ default: &818
value:
- email: octocat@github.com
verified: true
@@ -114798,7 +114130,7 @@ paths:
application/json:
schema:
type: array
- items: *811
+ items: *806
examples:
default:
value:
@@ -115054,7 +114386,7 @@ paths:
application/json:
schema:
type: array
- items: &812
+ items: &807
title: GPG Key
description: A unique encryption key
type: object
@@ -115185,7 +114517,7 @@ paths:
- subkeys
- revoked
examples:
- default: &837
+ default: &832
value:
- id: 3
name: Octocat's GPG Key
@@ -115270,9 +114602,9 @@ paths:
description: Response
content:
application/json:
- schema: *812
+ schema: *807
examples:
- default: &813
+ default: &808
value:
id: 3
name: Octocat's GPG Key
@@ -115329,7 +114661,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &814
+ - &809
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -115341,9 +114673,9 @@ paths:
description: Response
content:
application/json:
- schema: *812
+ schema: *807
examples:
- default: *813
+ default: *808
'404': *6
'304': *37
'403': *29
@@ -115366,7 +114698,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *814
+ - *809
responses:
'204':
description: Response
@@ -115671,7 +115003,7 @@ paths:
required: true
content:
application/json:
- schema: *649
+ schema: *646
examples:
default:
value:
@@ -115821,7 +115153,7 @@ paths:
application/json:
schema:
type: array
- items: &815
+ items: &810
title: Key
description: Key
type: object
@@ -115922,9 +115254,9 @@ paths:
description: Response
content:
application/json:
- schema: *815
+ schema: *810
examples:
- default: &816
+ default: &811
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -115957,15 +115289,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *680
+ - *677
responses:
'200':
description: Response
content:
application/json:
- schema: *815
+ schema: *810
examples:
- default: *816
+ default: *811
'404': *6
'304': *37
'403': *29
@@ -115988,7 +115320,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *680
+ - *677
responses:
'204':
description: Response
@@ -116021,7 +115353,7 @@ paths:
application/json:
schema:
type: array
- items: &817
+ items: &812
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -116089,7 +115421,7 @@ paths:
- account
- plan
examples:
- default: &818
+ default: &813
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -116151,9 +115483,9 @@ paths:
application/json:
schema:
type: array
- items: *817
+ items: *812
examples:
- default: *818
+ default: *813
headers:
Link: *47
'304': *37
@@ -117162,7 +116494,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository
parameters:
- *382
- - *819
+ - *814
responses:
'204':
description: Response
@@ -117277,7 +116609,7 @@ paths:
- docker
- nuget
- container
- - *820
+ - *815
- *19
- *17
responses:
@@ -117289,8 +116621,8 @@ paths:
type: array
items: *387
examples:
- default: *821
- '400': *822
+ default: *816
+ '400': *817
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -117319,7 +116651,7 @@ paths:
application/json:
schema: *387
examples:
- default: &838
+ default: &833
value:
id: 40201
name: octo-name
@@ -117681,9 +117013,9 @@ paths:
application/json:
schema:
type: array
- items: *811
+ items: *806
examples:
- default: *823
+ default: *818
headers:
Link: *47
'304': *37
@@ -117796,7 +117128,7 @@ paths:
type: array
items: *78
examples:
- default: &830
+ default: &825
summary: Default response
value:
- id: 1296269
@@ -118100,9 +117432,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
+ default: *463
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -118140,9 +117472,9 @@ paths:
application/json:
schema:
type: array
- items: *651
+ items: *648
examples:
- default: *824
+ default: *819
headers:
Link: *47
'304': *37
@@ -118221,7 +117553,7 @@ paths:
application/json:
schema:
type: array
- items: &825
+ items: &820
title: Social account
description: Social media account
type: object
@@ -118236,7 +117568,7 @@ paths:
- provider
- url
examples:
- default: &826
+ default: &821
value:
- provider: twitter
url: https://twitter.com/github
@@ -118298,9 +117630,9 @@ paths:
application/json:
schema:
type: array
- items: *825
+ items: *820
examples:
- default: *826
+ default: *821
'422': *15
'304': *37
'404': *6
@@ -118387,7 +117719,7 @@ paths:
application/json:
schema:
type: array
- items: &827
+ items: &822
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -118407,7 +117739,7 @@ paths:
- title
- created_at
examples:
- default: &852
+ default: &847
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -118471,9 +117803,9 @@ paths:
description: Response
content:
application/json:
- schema: *827
+ schema: *822
examples:
- default: &828
+ default: &823
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -118503,7 +117835,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &829
+ - &824
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -118515,9 +117847,9 @@ paths:
description: Response
content:
application/json:
- schema: *827
+ schema: *822
examples:
- default: *828
+ default: *823
'404': *6
'304': *37
'403': *29
@@ -118540,7 +117872,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *829
+ - *824
responses:
'204':
description: Response
@@ -118569,7 +117901,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &853
+ - &848
name: sort
description: The property to sort the results by. `created` means when the
repository was starred. `updated` means when the repository was last pushed
@@ -118594,11 +117926,11 @@ paths:
type: array
items: *78
examples:
- default-response: *830
+ default-response: *825
application/vnd.github.v3.star+json:
schema:
type: array
- items: &854
+ items: &849
title: Starred Repository
description: Starred Repository
type: object
@@ -118754,8 +118086,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response if this repository is starred by you
@@ -118783,8 +118115,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -118808,8 +118140,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -118967,10 +118299,10 @@ paths:
application/json:
schema:
oneOf:
- - *804
- - *803
+ - *799
+ - *798
examples:
- default-response: &832
+ default-response: &827
summary: Default response
value:
login: octocat
@@ -119005,7 +118337,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &833
+ response-with-git-hub-plan-information: &828
summary: Response with GitHub plan information
value:
login: octocat
@@ -119127,7 +118459,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users
parameters:
- - *831
+ - *826
- *17
responses:
'200':
@@ -119176,11 +118508,11 @@ paths:
application/json:
schema:
oneOf:
- - *804
- - *803
+ - *799
+ - *798
examples:
- default-response: *832
- response-with-git-hub-plan-information: *833
+ default-response: *827
+ response-with-git-hub-plan-information: *828
'404': *6
x-github:
githubCloudOnly: false
@@ -119230,8 +118562,8 @@ paths:
required:
- subject_digests
examples:
- default: *834
- withPredicateType: *835
+ default: *829
+ withPredicateType: *830
responses:
'200':
description: Response
@@ -119284,7 +118616,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *836
+ default: *831
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -119489,7 +118821,7 @@ paths:
initiator:
type: string
examples:
- default: *506
+ default: *503
'201':
description: Response
content:
@@ -119530,7 +118862,7 @@ paths:
type: array
items: *387
examples:
- default: *821
+ default: *816
'403': *29
'401': *25
x-github:
@@ -119914,9 +119246,9 @@ paths:
application/json:
schema:
type: array
- items: *812
+ items: *807
examples:
- default: *837
+ default: *832
headers:
Link: *47
x-github:
@@ -120020,7 +119352,7 @@ paths:
application/json:
schema: *22
examples:
- default: *648
+ default: *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120144,7 +119476,7 @@ paths:
- docker
- nuget
- container
- - *820
+ - *815
- *143
- *19
- *17
@@ -120157,10 +119489,10 @@ paths:
type: array
items: *387
examples:
- default: *821
+ default: *816
'403': *29
'401': *25
- '400': *822
+ '400': *817
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120190,7 +119522,7 @@ paths:
application/json:
schema: *387
examples:
- default: *838
+ default: *833
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120539,7 +119871,7 @@ paths:
type: array
items: *409
examples:
- default: *839
+ default: *834
headers:
Link: *47
'304': *37
@@ -120599,7 +119931,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *840
+ items: *835
required:
- name
- data_type
@@ -120615,7 +119947,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *841
+ iteration_configuration: *836
required:
- name
- data_type
@@ -120637,8 +119969,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *842
- iteration_field: *843
+ single_select_field: *837
+ iteration_field: *838
responses:
'201':
description: Response
@@ -120646,11 +119978,11 @@ paths:
application/json:
schema: *409
examples:
- text_field: *844
- number_field: *845
- date_field: *846
- single_select_field: *847
- iteration_field: *848
+ text_field: *839
+ number_field: *840
+ date_field: *841
+ single_select_field: *842
+ iteration_field: *843
'304': *37
'403': *29
'401': *25
@@ -120672,7 +120004,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user
parameters:
- *405
- - *849
+ - *844
- *143
responses:
'200':
@@ -120681,7 +120013,7 @@ paths:
application/json:
schema: *409
examples:
- default: *850
+ default: *845
headers:
Link: *47
'304': *37
@@ -121035,7 +120367,7 @@ paths:
parameters:
- *405
- *143
- - *851
+ - *846
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -121314,9 +120646,9 @@ paths:
application/json:
schema:
type: array
- items: *825
+ items: *820
examples:
- default: *826
+ default: *821
headers:
Link: *47
x-github:
@@ -121346,9 +120678,9 @@ paths:
application/json:
schema:
type: array
- items: *827
+ items: *822
examples:
- default: *852
+ default: *847
headers:
Link: *47
x-github:
@@ -121373,7 +120705,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *143
- - *853
+ - *848
- *110
- *17
- *19
@@ -121385,11 +120717,11 @@ paths:
schema:
anyOf:
- type: array
- items: *854
+ items: *849
- type: array
items: *78
examples:
- default-response: *830
+ default-response: *825
headers:
Link: *47
x-github:
@@ -121548,7 +120880,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &855
+ enterprise: &850
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -121606,7 +120938,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &856
+ installation: &851
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -121625,7 +120957,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &857
+ organization: &852
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -121685,13 +121017,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &858
+ repository: &853
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: &895
+ properties: &890
id:
description: Unique identifier of the repository
example: 42
@@ -122374,7 +121706,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &896
+ required: &891
- archive_url
- assignees_url
- blobs_url
@@ -122525,10 +121857,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -122604,11 +121936,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- rule: &859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ rule: &854
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -122831,11 +122163,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- rule: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ rule: *854
sender: *4
required:
- action
@@ -123018,11 +122350,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- rule: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ rule: *854
sender: *4
required:
- action
@@ -123095,7 +122427,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &879
+ schema: &874
title: Exemption request cancellation event
type: object
properties:
@@ -123103,11 +122435,11 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: &860
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: &855
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -123376,7 +122708,7 @@ x-webhooks:
type: array
description: The responses to the exemption request.
nullable: true
- items: &861
+ items: &856
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -123486,7 +122818,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &880
+ schema: &875
title: Exemption request completed event
type: object
properties:
@@ -123494,11 +122826,11 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: *860
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: *855
sender: *4
required:
- action
@@ -123570,7 +122902,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &877
+ schema: &872
title: Exemption request created event
type: object
properties:
@@ -123578,11 +122910,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: *860
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: *855
sender: *4
required:
- action
@@ -123654,7 +122986,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &881
+ schema: &876
title: Exemption response dismissed event
type: object
properties:
@@ -123662,12 +122994,12 @@ x-webhooks:
type: string
enum:
- response_dismissed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: *860
- exemption_response: *861
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: *855
+ exemption_response: *856
sender: *4
required:
- action
@@ -123741,7 +123073,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &878
+ schema: &873
title: Exemption response submitted event
type: object
properties:
@@ -123749,12 +123081,12 @@ x-webhooks:
type: string
enum:
- response_submitted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: *860
- exemption_response: *861
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: *855
+ exemption_response: *856
sender: *4
required:
- action
@@ -123838,7 +123170,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &863
+ check_run: &858
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -123929,7 +123261,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *862
+ deployment: *857
details_url:
example: https://example.com
type: string
@@ -124014,10 +123346,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *856
- enterprise: *855
- organization: *857
- repository: *858
+ installation: *851
+ enterprise: *850
+ organization: *852
+ repository: *853
sender: *4
required:
- check_run
@@ -124410,11 +123742,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *863
- installation: *856
- enterprise: *855
- organization: *857
- repository: *858
+ check_run: *858
+ installation: *851
+ enterprise: *850
+ organization: *852
+ repository: *853
sender: *4
required:
- check_run
@@ -124810,11 +124142,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *863
- installation: *856
- enterprise: *855
- organization: *857
- repository: *858
+ check_run: *858
+ installation: *851
+ enterprise: *850
+ organization: *852
+ repository: *853
requested_action:
description: The action requested by the user.
type: object
@@ -125219,11 +124551,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *863
- installation: *856
- enterprise: *855
- organization: *857
- repository: *858
+ check_run: *858
+ installation: *851
+ enterprise: *850
+ organization: *852
+ repository: *853
sender: *4
required:
- check_run
@@ -126200,10 +125532,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -126897,10 +126229,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -127588,10 +126920,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -127757,7 +127089,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -127902,20 +127234,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &864
+ commit_oid: &859
description: The commit SHA of the code scanning alert. When the
action is `reopened_by_user` or `closed_by_user`, the event was
triggered by the `sender` and this value will be empty.
type: string
- enterprise: *855
- installation: *856
- organization: *857
- ref: &865
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: &860
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -128080,7 +127412,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -128310,12 +127642,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *864
- enterprise: *855
- installation: *856
- organization: *857
- ref: *865
- repository: *858
+ commit_oid: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: *860
+ repository: *853
sender: *4
required:
- action
@@ -128410,7 +127742,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -128581,12 +127913,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *864
- enterprise: *855
- installation: *856
- organization: *857
- ref: *865
- repository: *858
+ commit_oid: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: *860
+ repository: *853
sender: *4
required:
- action
@@ -128752,7 +128084,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -128918,12 +128250,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *864
- enterprise: *855
- installation: *856
- organization: *857
- ref: *865
- repository: *858
+ commit_oid: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: *860
+ repository: *853
sender: *4
required:
- action
@@ -129022,7 +128354,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -129197,16 +128529,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
nullable: true
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -129303,7 +128635,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -129443,12 +128775,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *864
- enterprise: *855
- installation: *856
- organization: *857
- ref: *865
- repository: *858
+ commit_oid: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: *860
+ repository: *853
sender: *4
required:
- action
@@ -129614,7 +128946,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -129759,10 +129091,10 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -130017,10 +129349,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -130100,18 +129432,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *857
- pusher_type: &866
+ organization: *852
+ pusher_type: &861
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &867
+ ref: &862
description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference)
resource.
type: string
@@ -130121,7 +129453,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *858
+ repository: *853
sender: *4
required:
- ref
@@ -130204,9 +129536,9 @@ x-webhooks:
enum:
- created
definition: *157
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -130291,9 +129623,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -130371,9 +129703,9 @@ x-webhooks:
enum:
- promote_to_enterprise
definition: *157
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -130451,9 +129783,9 @@ x-webhooks:
enum:
- updated
definition: *157
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -130530,10 +129862,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- repository: *858
- organization: *857
+ enterprise: *850
+ installation: *851
+ repository: *853
+ organization: *852
sender: *4
new_property_values:
type: array
@@ -130618,18 +129950,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
- pusher_type: *866
- ref: *867
+ enterprise: *850
+ installation: *851
+ organization: *852
+ pusher_type: *861
+ ref: *862
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *858
+ repository: *853
sender: *4
required:
- ref
@@ -130713,11 +130045,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -130801,11 +130133,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -130889,11 +130221,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -130975,11 +130307,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -131061,11 +130393,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -131148,11 +130480,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -131234,11 +130566,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -131315,9 +130647,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- key: &868
+ enterprise: *850
+ installation: *851
+ key: &863
description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -131353,8 +130685,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -131431,11 +130763,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- key: *868
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ key: *863
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -131996,12 +131328,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: &872
+ workflow: &867
title: Workflow
type: object
nullable: true
@@ -132727,13 +132059,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *603
+ deployment: *600
pull_requests:
type: array
- items: *701
- repository: *858
- organization: *857
- installation: *856
+ items: *698
+ repository: *853
+ organization: *852
+ installation: *851
sender: *4
responses:
'200':
@@ -132804,7 +132136,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &869
+ approver: &864
type: object
properties:
avatar_url:
@@ -132847,11 +132179,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- reviewers: &870
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ reviewers: &865
type: array
items:
type: object
@@ -132930,7 +132262,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &871
+ workflow_job_run: &866
type: object
properties:
conclusion:
@@ -133661,18 +132993,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *869
+ approver: *864
comment:
type: string
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- reviewers: *870
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ reviewers: *865
sender: *4
since:
type: string
- workflow_job_run: *871
+ workflow_job_run: *866
workflow_job_runs:
type: array
items:
@@ -134376,13 +133708,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *855
+ enterprise: *850
environment:
type: string
- installation: *856
- organization: *857
- repository: *858
- requestor: &882
+ installation: *851
+ organization: *852
+ repository: *853
+ requestor: &877
title: User
type: object
nullable: true
@@ -136281,12 +135613,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: *872
+ workflow: *867
workflow_run:
title: Deployment Workflow Run
type: object
@@ -136966,7 +136298,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &875
+ answer: &870
type: object
properties:
author_association:
@@ -137123,11 +136455,11 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137254,11 +136586,11 @@ x-webhooks:
- from
required:
- category
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137341,11 +136673,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137427,7 +136759,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &874
+ comment: &869
type: object
properties:
author_association:
@@ -137584,11 +136916,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137671,12 +137003,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *874
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ comment: *869
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137771,12 +137103,12 @@ x-webhooks:
- from
required:
- body
- comment: *874
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ comment: *869
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137860,11 +137192,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137946,11 +137278,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138050,11 +137382,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138136,10 +137468,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *873
- enterprise: *855
- installation: *856
- label: &876
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ label: &871
title: Label
type: object
properties:
@@ -138171,8 +137503,8 @@ x-webhooks:
- color
- default
- description
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138255,11 +137587,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138341,11 +137673,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138427,11 +137759,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138516,16 +137848,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *873
- new_repository: *858
+ new_discussion: *868
+ new_repository: *853
required:
- new_discussion
- new_repository
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138608,10 +137940,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *873
- old_answer: *875
- organization: *857
- repository: *858
+ discussion: *868
+ old_answer: *870
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138693,12 +138025,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *873
- enterprise: *855
- installation: *856
- label: *876
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138781,11 +138113,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138867,11 +138199,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138940,7 +138272,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *877
+ schema: *872
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139003,7 +138335,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *878
+ schema: *873
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139066,7 +138398,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *879
+ schema: *874
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139129,7 +138461,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *877
+ schema: *872
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139192,7 +138524,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *878
+ schema: *873
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139258,7 +138590,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *879
+ schema: *874
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139324,7 +138656,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *880
+ schema: *875
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139390,7 +138722,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *877
+ schema: *872
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139456,7 +138788,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *881
+ schema: *876
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139522,7 +138854,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *878
+ schema: *873
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139587,7 +138919,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *879
+ schema: *874
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139652,7 +138984,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *880
+ schema: *875
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139717,7 +139049,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *877
+ schema: *872
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139782,7 +139114,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *881
+ schema: *876
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139848,7 +139180,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *878
+ schema: *873
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139915,7 +139247,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *855
+ enterprise: *850
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository)
resource.
@@ -140575,9 +139907,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- forkee
@@ -140723,9 +140055,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pages:
description: The pages that were updated.
type: array
@@ -140762,7 +140094,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *858
+ repository: *853
sender: *4
required:
- pages
@@ -140838,10 +140170,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: &883
+ organization: *852
+ repositories: &878
description: An array of repository objects that the installation
can access.
type: array
@@ -140867,8 +140199,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *858
- requester: *882
+ repository: *853
+ requester: *877
sender: *4
required:
- action
@@ -140943,11 +140275,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: *883
- repository: *858
+ organization: *852
+ repositories: *878
+ repository: *853
requester:
nullable: true
sender: *4
@@ -141023,11 +140355,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: *883
- repository: *858
+ organization: *852
+ repositories: *878
+ repository: *853
requester:
nullable: true
sender: *4
@@ -141103,10 +140435,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories_added: &884
+ organization: *852
+ repositories_added: &879
description: An array of repository objects, which were added to
the installation.
type: array
@@ -141152,15 +140484,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *858
- repository_selection: &885
+ repository: *853
+ repository_selection: &880
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *882
+ requester: *877
sender: *4
required:
- action
@@ -141239,10 +140571,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories_added: *884
+ organization: *852
+ repositories_added: *879
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -141269,9 +140601,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *858
- repository_selection: *885
- requester: *882
+ repository: *853
+ repository_selection: *880
+ requester: *877
sender: *4
required:
- action
@@ -141350,11 +140682,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: *883
- repository: *858
+ organization: *852
+ repositories: *878
+ repository: *853
requester:
nullable: true
sender: *4
@@ -141533,10 +140865,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
target_type:
type: string
@@ -141615,11 +140947,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: *883
- repository: *858
+ organization: *852
+ repositories: *878
+ repository: *853
requester:
nullable: true
sender: *4
@@ -141871,8 +141203,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -142666,8 +141998,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143016,8 +142348,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -143097,7 +142429,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &886
+ comment: &881
title: issue comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment)
itself.
@@ -143262,8 +142594,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -144053,8 +143385,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -144405,8 +143737,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -144486,7 +143818,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &915
+ changes: &910
description: The changes to the comment.
type: object
properties:
@@ -144498,9 +143830,9 @@ x-webhooks:
type: string
required:
- from
- comment: *886
- enterprise: *855
- installation: *856
+ comment: *881
+ enterprise: *850
+ installation: *851
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -145293,8 +144625,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -145643,8 +144975,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -145734,9 +145066,9 @@ x-webhooks:
type: number
blocking_issue: *221
blocking_issue_repo: *78
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -145825,9 +145157,9 @@ x-webhooks:
type: number
blocking_issue: *221
blocking_issue_repo: *78
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -145915,9 +145247,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -146006,9 +145338,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -146088,10 +145420,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *882
- enterprise: *855
- installation: *856
- issue: &889
+ assignee: *877
+ enterprise: *850
+ installation: *851
+ issue: &884
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -146880,11 +146212,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -147001,8 +146333,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -147082,8 +146414,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -147877,11 +147209,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -148133,8 +147465,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -148213,8 +147545,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -148999,11 +148331,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -149119,8 +148451,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -149199,8 +148531,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -150007,11 +149339,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -150106,7 +149438,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &887
+ milestone: &882
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -150244,8 +149576,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -150344,8 +149676,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -151134,11 +150466,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -151255,9 +150587,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *876
- organization: *857
- repository: *858
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -151337,8 +150669,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -152126,11 +151458,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -152247,9 +151579,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *876
- organization: *857
- repository: *858
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -152329,8 +151661,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -153142,11 +152474,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -153240,8 +152572,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -153320,8 +152652,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -154127,11 +153459,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -154225,9 +153557,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *887
- organization: *857
- repository: *858
+ milestone: *882
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -155095,11 +154427,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -155661,8 +154993,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -156451,11 +155783,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -156571,8 +155903,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -156652,9 +155984,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *855
- installation: *856
- issue: &888
+ enterprise: *850
+ installation: *851
+ issue: &883
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -157437,11 +156769,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -157557,8 +156889,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -157637,8 +156969,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -158448,11 +157780,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -158547,8 +157879,8 @@ x-webhooks:
user_view_type:
type: string
type: *371
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -159414,11 +158746,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -160002,11 +159334,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *855
- installation: *856
- issue: *888
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ issue: *883
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -160086,12 +159418,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *855
- installation: *856
- issue: *889
+ enterprise: *850
+ installation: *851
+ issue: *884
type: *371
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -160172,7 +159504,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &918
+ assignee: &913
title: User
type: object
nullable: true
@@ -160242,11 +159574,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *855
- installation: *856
- issue: *889
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ issue: *884
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -160325,12 +159657,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *855
- installation: *856
- issue: *889
- label: *876
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ issue: *884
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -160410,8 +159742,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -161221,11 +160553,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -161319,8 +160651,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161400,11 +160732,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *855
- installation: *856
- issue: *888
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ issue: *883
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161483,12 +160815,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *855
- installation: *856
- issue: *889
+ enterprise: *850
+ installation: *851
+ issue: *884
type: *371
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161568,11 +160900,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- label: *876
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161650,11 +160982,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- label: *876
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161764,11 +161096,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- label: *876
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161850,9 +161182,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *855
- installation: *856
- marketplace_purchase: &890
+ enterprise: *850
+ installation: *851
+ marketplace_purchase: &885
title: Marketplace Purchase
type: object
required:
@@ -161935,8 +161267,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *857
- previous_marketplace_purchase: &891
+ organization: *852
+ previous_marketplace_purchase: &886
title: Marketplace Purchase
type: object
properties:
@@ -162016,7 +161348,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -162096,10 +161428,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *855
- installation: *856
- marketplace_purchase: *890
- organization: *857
+ enterprise: *850
+ installation: *851
+ marketplace_purchase: *885
+ organization: *852
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162182,7 +161514,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -162264,10 +161596,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *855
- installation: *856
- marketplace_purchase: *890
- organization: *857
+ enterprise: *850
+ installation: *851
+ marketplace_purchase: *885
+ organization: *852
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162349,7 +161681,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -162430,8 +161762,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162513,9 +161845,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *857
- previous_marketplace_purchase: *891
- repository: *858
+ organization: *852
+ previous_marketplace_purchase: *886
+ repository: *853
sender: *4
required:
- action
@@ -162595,12 +161927,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *855
- installation: *856
- marketplace_purchase: *890
- organization: *857
- previous_marketplace_purchase: *891
- repository: *858
+ enterprise: *850
+ installation: *851
+ marketplace_purchase: *885
+ organization: *852
+ previous_marketplace_purchase: *886
+ repository: *853
sender: *4
required:
- action
@@ -162702,11 +162034,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -162806,11 +162138,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -162889,11 +162221,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -162971,11 +162303,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -163051,7 +162383,7 @@ x-webhooks:
required:
- login
- id
- team: &892
+ team: &887
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -163274,11 +162606,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -163355,7 +162687,7 @@ x-webhooks:
required:
- login
- id
- team: *892
+ team: *887
required:
- action
- scope
@@ -163437,8 +162769,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *856
- merge_group: &894
+ installation: *851
+ merge_group: &889
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -163457,15 +162789,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *893
+ head_commit: *888
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -163551,10 +162883,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *856
- merge_group: *894
- organization: *857
- repository: *858
+ installation: *851
+ merge_group: *889
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -163627,7 +162959,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
+ enterprise: *850
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -163736,16 +163068,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *895
- required: *896
+ properties: *890
+ required: *891
nullable: true
sender: *4
required:
@@ -163826,11 +163158,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *855
- installation: *856
- milestone: *887
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ milestone: *882
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -163909,9 +163241,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- milestone: &897
+ enterprise: *850
+ installation: *851
+ milestone: &892
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -164048,8 +163380,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164128,11 +163460,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- milestone: *887
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ milestone: *882
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164242,11 +163574,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- milestone: *887
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ milestone: *882
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164326,11 +163658,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *855
- installation: *856
- milestone: *897
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ milestone: *892
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164409,11 +163741,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *882
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ blocked_user: *877
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164492,11 +163824,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *882
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ blocked_user: *877
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164572,7 +163904,7 @@ x-webhooks:
enum:
- created
definition: *151
- enterprise: *855
+ enterprise: *850
sender: *4
required:
- action
@@ -164652,8 +163984,8 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
sender: *4
required:
- action
@@ -164726,8 +164058,8 @@ x-webhooks:
enum:
- updated
definition: *151
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
sender: *4
required:
- action
@@ -164799,9 +164131,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
new_property_values:
type: array
@@ -164889,9 +164221,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- membership: &898
+ enterprise: *850
+ installation: *851
+ membership: &893
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -164998,8 +164330,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -165077,11 +164409,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *855
- installation: *856
- membership: *898
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ membership: *893
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -165160,8 +164492,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -165277,10 +164609,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
- user: *882
+ user: *877
required:
- action
- invitation
@@ -165358,11 +164690,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *855
- installation: *856
- membership: *898
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ membership: *893
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -165449,11 +164781,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *855
- installation: *856
- membership: *898
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ membership: *893
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -165529,9 +164861,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
package:
description: Information about the package.
type: object
@@ -166030,7 +165362,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &899
+ items: &894
title: Ruby Gems metadata
type: object
properties:
@@ -166125,7 +165457,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -166201,9 +165533,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
package:
description: Information about the package.
type: object
@@ -166556,7 +165888,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *899
+ items: *894
source_url:
type: string
format: uri
@@ -166626,7 +165958,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -166803,12 +166135,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *855
+ enterprise: *850
id:
type: integer
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- id
@@ -166885,7 +166217,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &900
+ personal_access_token_request: &895
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -167031,10 +166363,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *855
- organization: *857
+ enterprise: *850
+ organization: *852
sender: *4
- installation: *856
+ installation: *851
required:
- action
- personal_access_token_request
@@ -167111,11 +166443,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *900
- enterprise: *855
- organization: *857
+ personal_access_token_request: *895
+ enterprise: *850
+ organization: *852
sender: *4
- installation: *856
+ installation: *851
required:
- action
- personal_access_token_request
@@ -167191,11 +166523,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *900
- enterprise: *855
- organization: *857
+ personal_access_token_request: *895
+ enterprise: *850
+ organization: *852
sender: *4
- installation: *856
+ installation: *851
required:
- action
- personal_access_token_request
@@ -167270,11 +166602,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *900
- organization: *857
- enterprise: *855
+ personal_access_token_request: *895
+ organization: *852
+ enterprise: *850
sender: *4
- installation: *856
+ installation: *851
required:
- action
- personal_access_token_request
@@ -167379,7 +166711,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *901
+ last_response: *896
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -167411,8 +166743,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
zen:
description: Random string of GitHub zen.
@@ -167657,10 +166989,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *855
- installation: *856
- organization: *857
- project_card: &902
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_card: &897
title: Project Card
type: object
properties:
@@ -167779,7 +167111,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -167860,11 +167192,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- project_card: *902
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_card: *897
+ repository: *853
sender: *4
required:
- action
@@ -167944,9 +167276,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
project_card:
title: Project Card
type: object
@@ -168074,8 +167406,8 @@ x-webhooks:
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *895
- required: *896
+ properties: *890
+ required: *891
nullable: true
sender: *4
required:
@@ -168169,11 +167501,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *855
- installation: *856
- organization: *857
- project_card: *902
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_card: *897
+ repository: *853
sender: *4
required:
- action
@@ -168267,9 +167599,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
project_card:
allOf:
- title: Project Card
@@ -168459,7 +167791,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -168539,10 +167871,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *855
- installation: *856
- organization: *857
- project: &904
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: &899
title: Project
type: object
properties:
@@ -168666,7 +167998,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -168746,10 +168078,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- project_column: &903
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_column: &898
title: Project Column
type: object
properties:
@@ -168788,7 +168120,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -168867,18 +168199,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- project_column: *903
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_column: *898
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *895
- required: *896
+ properties: *890
+ required: *891
nullable: true
sender: *4
required:
@@ -168968,11 +168300,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- project_column: *903
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_column: *898
+ repository: *853
sender: *4
required:
- action
@@ -169052,11 +168384,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *855
- installation: *856
- organization: *857
- project_column: *903
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_column: *898
+ repository: *853
sender: *4
required:
- action
@@ -169136,11 +168468,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- project: *904
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: *899
+ repository: *853
sender: *4
required:
- action
@@ -169220,18 +168552,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- project: *904
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: *899
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *895
- required: *896
+ properties: *890
+ required: *891
nullable: true
sender: *4
required:
@@ -169333,11 +168665,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- project: *904
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: *899
+ repository: *853
sender: *4
required:
- action
@@ -169416,11 +168748,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *855
- installation: *856
- organization: *857
- project: *904
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: *899
+ repository: *853
sender: *4
required:
- action
@@ -169501,8 +168833,8 @@ x-webhooks:
type: string
enum:
- closed
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -169584,8 +168916,8 @@ x-webhooks:
type: string
enum:
- created
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -169667,8 +168999,8 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -169786,8 +169118,8 @@ x-webhooks:
type: string
to:
type: string
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -169871,7 +169203,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &908
+ changes: &903
type: object
properties:
archived_at:
@@ -169885,9 +169217,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *856
- organization: *857
- projects_v2_item: &905
+ installation: *851
+ organization: *852
+ projects_v2_item: &900
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -170022,9 +169354,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170106,9 +169438,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170189,9 +169521,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170297,7 +169629,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &906
+ - &901
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -170319,7 +169651,7 @@ x-webhooks:
required:
- id
- name
- - &907
+ - &902
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -170353,8 +169685,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *906
- - *907
+ - *901
+ - *902
required:
- field_value
- type: object
@@ -170370,9 +169702,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170467,9 +169799,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170552,10 +169884,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *908
- installation: *856
- organization: *857
- projects_v2_item: *905
+ changes: *903
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170637,8 +169969,8 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -170720,14 +170052,14 @@ x-webhooks:
type: string
enum:
- created
- installation: *856
- organization: *857
- projects_v2_status_update: &911
+ installation: *851
+ organization: *852
+ projects_v2_status_update: &906
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: *909
- required: *910
+ properties: *904
+ required: *905
sender: *4
required:
- action
@@ -170808,9 +170140,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *856
- organization: *857
- projects_v2_status_update: *911
+ installation: *851
+ organization: *852
+ projects_v2_status_update: *906
sender: *4
required:
- action
@@ -170946,9 +170278,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *856
- organization: *857
- projects_v2_status_update: *911
+ installation: *851
+ organization: *852
+ projects_v2_status_update: *906
sender: *4
required:
- action
@@ -171019,10 +170351,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- repository
@@ -171099,13 +170431,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *882
- enterprise: *855
- installation: *856
- number: &912
+ assignee: *877
+ enterprise: *850
+ installation: *851
+ number: &907
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -173388,7 +172720,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -173470,11 +172802,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -175752,7 +175084,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -175834,11 +175166,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -178116,7 +177448,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -178198,13 +177530,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: &913
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: &908
allOf:
- - *701
+ - *698
- type: object
properties:
allow_auto_merge:
@@ -178266,7 +177598,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -178347,12 +177679,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -178432,11 +177764,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *855
- milestone: *683
- number: *912
- organization: *857
- pull_request: &914
+ enterprise: *850
+ milestone: *680
+ number: *907
+ organization: *852
+ pull_request: &909
title: Pull Request
type: object
properties:
@@ -180699,7 +180031,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -180778,11 +180110,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -183064,7 +182396,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -183188,12 +182520,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -183273,11 +182605,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -185544,7 +184876,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -185624,11 +184956,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *855
- installation: *856
- label: *876
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ label: *871
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -187910,7 +187242,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -187991,10 +187323,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -190274,7 +189606,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -190354,12 +189686,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *855
- milestone: *683
- number: *912
- organization: *857
- pull_request: *914
- repository: *858
+ enterprise: *850
+ milestone: *680
+ number: *907
+ organization: *852
+ pull_request: *909
+ repository: *853
sender: *4
required:
- action
@@ -190438,12 +189770,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -190524,12 +189856,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -190609,12 +189941,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -190980,9 +190312,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
type: object
properties:
@@ -193152,7 +192484,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -193232,7 +192564,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &916
+ comment: &911
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -193517,9 +192849,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
type: object
properties:
@@ -195677,7 +195009,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -195757,11 +195089,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *915
- comment: *916
- enterprise: *855
- installation: *856
- organization: *857
+ changes: *910
+ comment: *911
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
type: object
properties:
@@ -197922,7 +197254,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -198003,9 +197335,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -200178,7 +199510,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
+ repository: *853
review:
description: The review that was affected.
type: object
@@ -200425,9 +199757,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -202481,8 +201813,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
- review: &917
+ repository: *853
+ review: &912
description: The review that was affected.
type: object
properties:
@@ -202715,12 +202047,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -205003,7 +204335,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
requested_reviewer:
title: User
type: object
@@ -205087,12 +204419,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -207382,7 +206714,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -207574,12 +206906,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -209864,7 +209196,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
requested_reviewer:
title: User
type: object
@@ -209949,12 +209281,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -212230,7 +211562,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -212411,9 +211743,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -214588,8 +213920,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
- review: *917
+ repository: *853
+ review: *912
sender: *4
required:
- action
@@ -214669,9 +214001,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -216741,7 +216073,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
thread:
type: object
@@ -217128,9 +216460,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -219186,7 +218518,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
thread:
type: object
@@ -219576,10 +218908,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -221850,7 +221182,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -221932,11 +221264,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *918
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
+ assignee: *913
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -224219,7 +223551,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -224298,11 +223630,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *855
- installation: *856
- label: *876
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ label: *871
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -226575,7 +225907,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -226656,10 +225988,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -228924,7 +228256,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -229124,7 +228456,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *855
+ enterprise: *850
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -229216,8 +228548,8 @@ x-webhooks:
- url
- author
- committer
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -229792,9 +229124,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
registry_package:
type: object
properties:
@@ -230240,7 +229572,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *899
+ items: *894
summary:
type: string
tag_name:
@@ -230294,7 +229626,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -230372,9 +229704,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
registry_package:
type: object
properties:
@@ -230682,7 +230014,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *899
+ items: *894
summary:
type: string
tag_name:
@@ -230731,7 +230063,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -230808,10 +230140,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- release: &919
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: &914
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -231129,7 +230461,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -231206,11 +230538,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- release: *919
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: *914
+ repository: *853
sender: *4
required:
- action
@@ -231327,11 +230659,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *855
- installation: *856
- organization: *857
- release: *919
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: *914
+ repository: *853
sender: *4
required:
- action
@@ -231409,9 +230741,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
release:
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
@@ -231733,7 +231065,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -231809,10 +231141,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
- release: &920
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: &915
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -232131,7 +231463,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -232207,11 +231539,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *855
- installation: *856
- organization: *857
- release: *919
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: *914
+ repository: *853
sender: *4
required:
- action
@@ -232287,11 +231619,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *855
- installation: *856
- organization: *857
- release: *920
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: *915
+ repository: *853
sender: *4
required:
- action
@@ -232367,11 +231699,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- repository_advisory: *753
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ repository_advisory: *750
sender: *4
required:
- action
@@ -232447,11 +231779,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- repository_advisory: *753
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ repository_advisory: *750
sender: *4
required:
- action
@@ -232527,10 +231859,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232607,10 +231939,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232688,10 +232020,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232775,10 +232107,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232890,10 +232222,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232965,10 +232297,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
status:
type: string
@@ -233049,10 +232381,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233129,10 +232461,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233226,10 +232558,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233309,10 +232641,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
repository_ruleset: *191
sender: *4
required:
@@ -233391,10 +232723,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
repository_ruleset: *191
sender: *4
required:
@@ -233473,10 +232805,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
repository_ruleset: *191
changes:
type: object
@@ -233538,16 +232870,16 @@ x-webhooks:
properties:
added:
type: array
- items: *721
+ items: *718
deleted:
type: array
- items: *721
+ items: *718
updated:
type: array
items:
type: object
properties:
- rule: *721
+ rule: *718
changes:
type: object
properties:
@@ -233781,10 +233113,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233862,10 +233194,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233943,7 +233275,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &921
+ alert: &916
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -234064,10 +233396,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234273,10 +233605,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234354,11 +233686,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *921
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *916
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234557,10 +233889,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234638,7 +233970,7 @@ x-webhooks:
type: string
enum:
- assigned
- alert: &922
+ alert: &917
type: object
properties:
number: *128
@@ -234757,10 +234089,10 @@ x-webhooks:
required: *21
nullable: true
assignee: *4
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234838,11 +234170,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234923,11 +234255,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *922
- installation: *856
- location: *923
- organization: *857
- repository: *858
+ alert: *917
+ installation: *851
+ location: *918
+ organization: *852
+ repository: *853
sender: *4
required:
- location
@@ -235165,11 +234497,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235247,11 +234579,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235329,11 +234661,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235411,12 +234743,12 @@ x-webhooks:
type: string
enum:
- unassigned
- alert: *922
+ alert: *917
assignee: *4
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235494,11 +234826,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235624,10 +234956,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *858
- enterprise: *855
- installation: *856
- organization: *857
+ repository: *853
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -235705,11 +235037,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- security_advisory: &924
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ security_advisory: &919
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -235892,11 +235224,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- security_advisory: *924
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ security_advisory: *919
sender: *4
required:
- action
@@ -235969,10 +235301,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -236157,10 +235489,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *419
- enterprise: *855
- installation: *856
- organization: *857
- repository: *464
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *461
sender: *4
required:
- changes
@@ -236238,12 +235570,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: &925
+ sponsorship: &920
type: object
properties:
created_at:
@@ -236544,12 +235876,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- sponsorship
@@ -236637,12 +235969,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- changes
@@ -236719,17 +236051,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &926
+ effective_date: &921
description: The `pending_cancellation` and `pending_tier_change`
event types will include the date the cancellation or tier change
will take effect.
type: string
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- sponsorship
@@ -236803,7 +236135,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &927
+ changes: &922
type: object
properties:
tier:
@@ -236847,13 +236179,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *926
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ effective_date: *921
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- changes
@@ -236930,13 +236262,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *927
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ changes: *922
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- changes
@@ -237010,10 +236342,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -237096,10 +236428,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -237519,15 +236851,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *855
+ enterprise: *850
id:
description: The unique identifier of the status.
type: integer
- installation: *856
+ installation: *851
name:
type: string
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
sha:
description: The Commit SHA.
@@ -237642,9 +236974,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -237734,9 +237066,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -237826,9 +237158,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -237918,9 +237250,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -237997,12 +237329,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- team: &928
+ team: &923
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -238225,9 +237557,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -238685,7 +238017,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- team
@@ -238761,9 +238093,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -239221,7 +238553,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- team
@@ -239298,9 +238630,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -239758,7 +239090,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- team
@@ -239902,9 +239234,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -240362,7 +239694,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- changes
@@ -240440,9 +239772,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -240900,7 +240232,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- team
@@ -240976,10 +240308,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -241052,16 +240384,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *855
+ enterprise: *850
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
ref:
type: string
- repository: *858
+ repository: *853
sender: *4
workflow:
type: string
@@ -241143,10 +240475,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
workflow_job:
allOf:
@@ -241383,7 +240715,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *603
+ deployment: *600
required:
- action
- repository
@@ -241462,10 +240794,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
workflow_job:
allOf:
@@ -241725,7 +241057,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *603
+ deployment: *600
required:
- action
- repository
@@ -241804,10 +241136,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
workflow_job:
type: object
@@ -241942,7 +241274,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *603
+ deployment: *600
required:
- action
- repository
@@ -242021,10 +241353,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
workflow_job:
type: object
@@ -242160,7 +241492,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *603
+ deployment: *600
required:
- action
- repository
@@ -242240,12 +241572,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: *872
+ workflow: *867
workflow_run:
title: Workflow Run
type: object
@@ -243244,12 +242576,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: *872
+ workflow: *867
workflow_run:
title: Workflow Run
type: object
@@ -244233,12 +243565,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: *872
+ workflow: *867
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json
index 941f70958..b102e60d4 100644
--- a/descriptions/ghec/dereferenced/ghec.deref.json
+++ b/descriptions/ghec/dereferenced/ghec.deref.json
@@ -250817,17 +250817,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
+ "/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List a connection between an external group and a team",
+ "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussions-in-org",
+ "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
},
"parameters": [
{
@@ -250847,19 +250847,380 @@
"schema": {
"type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroups",
+ "description": "A list of external groups available to be connected to a team",
+ "type": "object",
+ "properties": {
+ "groups": {
+ "description": "An array of external groups available to be mapped to a team",
+ "example": [
+ {
+ "group_id": 1,
+ "group_name": "group-azuread-test",
+ "updated_at": "2021-01-03 22:27:15:000 -700"
+ },
+ {
+ "group_id": 2,
+ "group_name": "group-azuread-test2",
+ "updated_at": "2021-06-03 22:27:15:000 -700"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00"
+ },
+ {
+ "group_id": "456",
+ "group_name": "Octocat docs members",
+ "updated_at": "2021-03-24T11:31:04-06:00"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "patch": {
+ "summary": "Update the connection between an external group and a team",
+ "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
},
{
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "group_id": {
+ "type": "integer",
+ "description": "External Group Id",
+ "example": 1
+ }
+ },
+ "required": [
+ "group_id"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroup",
+ "description": "Information about an external group's usage and its members",
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "teams",
+ "members"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name for the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The date when the group was last updated_at",
+ "example": "2021-01-03 22:27:15:000 -700",
+ "type": "string"
+ },
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "example": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "example": 1,
+ "type": "integer"
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "example": "team-test",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "example": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "member_id",
+ "member_login",
+ "member_name",
+ "member_email"
+ ],
+ "properties": {
+ "member_id": {
+ "description": "The internal user ID of the identity",
+ "example": 1,
+ "type": "integer"
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "example": "mona-lisa_eocsaxrs",
+ "type": "string"
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "example": "Mona Lisa",
+ "type": "string"
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "example": "mona_lisa@github.com",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00",
+ "teams": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "members": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "delete": {
+ "summary": "Remove the connection between an external group and a team",
+ "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/unlink-external-idp-group-from-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/invitations": {
+ "get": {
+ "summary": "List pending team invitations",
+ "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-pending-invitations-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
}
},
{
@@ -250879,15 +251240,6 @@
"type": "integer",
"default": 1
}
- },
- {
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
- "schema": {
- "type": "string"
- }
}
],
"responses": {
@@ -250898,11 +251250,37 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Organization Invitation",
+ "description": "Organization Invitation",
"type": "object",
"properties": {
- "author": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "login": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ },
+ "role": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "failed_at": {
+ "type": "string",
+ "nullable": true
+ },
+ "failed_reason": {
+ "type": "string",
+ "nullable": true
+ },
+ "inviter": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -251024,142 +251402,289 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
+ ]
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
+ "team_count": {
+ "type": "integer"
},
- "body_html": {
+ "node_id": {
"type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
+ "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ },
+ "invitation_teams_url": {
+ "type": "string",
+ "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ },
+ "invitation_source": {
+ "type": "string",
+ "example": "\"member\""
+ }
+ },
+ "required": [
+ "id",
+ "login",
+ "email",
+ "role",
+ "created_at",
+ "inviter",
+ "team_count",
+ "invitation_teams_url",
+ "node_id"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "id": 1,
+ "login": "monalisa",
+ "node_id": "MDQ6VXNlcjE=",
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "created_at": "2016-11-30T06:46:10-08:00",
+ "failed_at": "",
+ "failed_reason": "",
+ "inviter": {
+ "login": "other_user",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/other_user_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/other_user",
+ "html_url": "https://github.com/other_user",
+ "followers_url": "https://api.github.com/users/other_user/followers",
+ "following_url": "https://api.github.com/users/other_user/following{/other_user}",
+ "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
+ "organizations_url": "https://api.github.com/users/other_user/orgs",
+ "repos_url": "https://api.github.com/users/other_user/repos",
+ "events_url": "https://api.github.com/users/other_user/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/other_user/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "team_count": 2,
+ "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams",
+ "invitation_source": "member"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-members-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "member",
+ "maintainer",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "email": {
+ "nullable": true,
"type": "string"
},
- "created_at": {
+ "login": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
},
- "last_edited_at": {
+ "node_id": {
"type": "string",
- "format": "date-time",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
+ "example": "https://github.com/octocat"
},
- "node_id": {
+ "followers_url": {
"type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
},
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
},
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
- "team_url": {
+ "subscriptions_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
+ "example": "https://api.github.com/users/octocat/subscriptions"
},
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
},
- "updated_at": {
+ "repos_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
},
- "url": {
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "https://api.github.com/users/octocat/received_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"
- ]
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
"html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
"url"
]
}
@@ -251168,52 +251693,24 @@
"default": {
"value": [
{
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
}
]
}
@@ -251234,19 +251731,124 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
+ "get": {
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Membership",
+ "description": "Team Membership",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of the user's membership in the team.",
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "role",
+ "state",
+ "url"
+ ]
+ },
+ "examples": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
+ "value": {
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "if user has no team membership"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
}
},
- "post": {
- "summary": "Create a discussion",
- "description": "Creates 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\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-in-org",
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
},
"parameters": [
{
@@ -251266,39 +251868,40 @@
"schema": {
"type": "string"
}
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
}
],
"requestBody": {
- "required": true,
+ "required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
+ "role": {
"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
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
}
- },
- "required": [
- "title",
- "body"
- ]
+ }
},
"examples": {
"default": {
+ "summary": "Add or update team membership for an organization member",
"value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "role": "maintainer"
}
}
}
@@ -251306,1127 +251909,81 @@
}
},
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Team Membership",
+ "description": "Team Membership",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
"url": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "format": "uri"
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "default": "member",
+ "example": "member",
"type": "string"
},
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
+ "state": {
+ "description": "The state of the user's membership in the team.",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/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"
+ "enum": [
+ "active",
+ "pending"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
+ "role",
+ "state",
"url"
]
},
"examples": {
- "default": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
"value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "member",
+ "state": "pending"
}
}
}
}
}
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
},
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "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
- }
- }
- }
- }
- }
- }
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
}
},
"delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Remove 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/delete-discussion-in-org",
+ "operationId": "teams/remove-membership-for-user-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user"
},
"parameters": [
{
@@ -252448,39 +252005,42 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
"in": "path",
"required": true,
"schema": {
- "type": "integer"
+ "type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "members"
}
}
},
- "/orgs/{org}/teams/{team_slug}/external-groups": {
+ "/orgs/{org}/teams/{team_slug}/repos": {
"get": {
- "summary": "List a connection between an external group and a team",
- "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "summary": "List team repositories",
+ "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
"tags": [
"teams"
],
- "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
+ "operationId": "teams/list-repos-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-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/teams#list-team-repositories"
},
"parameters": [
{
@@ -252500,398 +252060,23 @@
"schema": {
"type": "string"
}
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroups",
- "description": "A list of external groups available to be connected to a team",
- "type": "object",
- "properties": {
- "groups": {
- "description": "An array of external groups available to be mapped to a team",
- "example": [
- {
- "group_id": 1,
- "group_name": "group-azuread-test",
- "updated_at": "2021-01-03 22:27:15:000 -700"
- },
- {
- "group_id": 2,
- "group_name": "group-azuread-test2",
- "updated_at": "2021-06-03 22:27:15:000 -700"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name of the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The time of the last update for this group",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00"
- },
- {
- "group_id": "456",
- "group_name": "Octocat docs members",
- "updated_at": "2021-03-24T11:31:04-06:00"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "patch": {
- "summary": "Update the connection between an external group and a team",
- "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/link-external-idp-group-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
+ },
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
+ "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": "string"
+ "type": "integer",
+ "default": 30
}
},
{
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
"schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "group_id": {
- "type": "integer",
- "description": "External Group Id",
- "example": 1
- }
- },
- "required": [
- "group_id"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "group_id": 123
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroup",
- "description": "Information about an external group's usage and its members",
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "teams",
- "members"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name for the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "example": "2021-01-03 22:27:15:000 -700",
- "type": "string"
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "example": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "example": 1,
- "type": "integer"
- },
- "team_name": {
- "description": "The name of the team",
- "example": "team-test",
- "type": "string"
- }
- }
- }
- },
- "members": {
- "description": "An array of external members linked to this group",
- "example": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "member_id",
- "member_login",
- "member_name",
- "member_email"
- ],
- "properties": {
- "member_id": {
- "description": "The internal user ID of the identity",
- "example": 1,
- "type": "integer"
- },
- "member_login": {
- "description": "The handle/login for the user",
- "example": "mona-lisa_eocsaxrs",
- "type": "string"
- },
- "member_name": {
- "description": "The user display name/profile name",
- "example": "Mona Lisa",
- "type": "string"
- },
- "member_email": {
- "description": "An email attached to a user",
- "example": "mona_lisa@github.com",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00",
- "teams": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "members": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "delete": {
- "summary": "Remove the connection between an external group and a team",
- "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/unlink-external-idp-group-from-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/invitations": {
- "get": {
- "summary": "List pending team invitations",
- "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-pending-invitations-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
+ "type": "integer",
+ "default": 1
}
}
],
@@ -252903,37 +252088,28 @@
"schema": {
"type": "array",
"items": {
- "title": "Organization Invitation",
- "description": "Organization Invitation",
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
"type": "object",
"properties": {
"id": {
"type": "integer",
- "format": "int64"
- },
- "login": {
- "type": "string",
- "nullable": true
+ "format": "int64",
+ "example": 1296269
},
- "email": {
+ "node_id": {
"type": "string",
- "nullable": true
- },
- "role": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
- "failed_at": {
+ "name": {
"type": "string",
- "nullable": true
+ "example": "Hello-World"
},
- "failed_reason": {
+ "full_name": {
"type": "string",
- "nullable": true
+ "example": "octocat/Hello-World"
},
- "inviter": {
+ "owner": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -253057,32 +252233,550 @@
"url"
]
},
- "team_count": {
+ "private": {
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string"
+ },
+ "mirror_url": {
+ "type": "string",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string"
+ },
+ "homepage": {
+ "type": "string",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
"type": "integer"
},
- "node_id": {
+ "stargazers_count": {
+ "type": "integer"
+ },
+ "watchers_count": {
+ "type": "integer"
+ },
+ "size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
+ "type": "integer"
+ },
+ "default_branch": {
+ "type": "string"
+ },
+ "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",
- "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\""
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
},
- "invitation_teams_url": {
+ "created_at": {
"type": "string",
- "example": "\"https://api.github.com/organizations/16/invitations/1/teams\""
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
},
- "invitation_source": {
+ "updated_at": {
"type": "string",
- "example": "\"member\""
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ }
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "code_of_conduct": {
+ "title": "Code Of Conduct",
+ "description": "Code Of Conduct",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "contributor_covenant"
+ },
+ "name": {
+ "type": "string",
+ "example": "Contributor Covenant"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ },
+ "body": {
+ "type": "string",
+ "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ }
+ },
+ "required": [
+ "url",
+ "html_url",
+ "key",
+ "name"
+ ]
+ },
+ "license": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "spdx_id": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "nullable": true
+ },
+ "forks": {
+ "type": "integer",
+ "example": 0
+ },
+ "open_issues": {
+ "type": "integer",
+ "example": 0
+ },
+ "watchers": {
+ "type": "integer",
+ "example": 0
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "security_and_analysis": {
+ "nullable": true,
+ "type": "object",
+ "properties": {
+ "advanced_security": {
+ "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n",
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "code_security": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "dependabot_security_updates": {
+ "description": "Enable or disable Dependabot security updates for the repository.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The enablement status of Dependabot security updates for the repository.",
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_push_protection": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_non_provider_patterns": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "secret_scanning_ai_detection": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "enabled",
+ "disabled"
+ ]
+ }
+ }
+ },
+ "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",
- "login",
- "email",
- "role",
- "created_at",
- "inviter",
- "team_count",
- "invitation_teams_url",
- "node_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"
]
}
},
@@ -253090,37 +252784,122 @@
"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": 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/other_user_happy.gif",
+ "avatar_url": "https://github.com/images/error/octocat_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",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/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"
+ "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"
+ }
+ }
}
]
}
@@ -253141,21 +252920,21 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "members"
+ "subcategory": "teams"
}
}
},
- "/orgs/{org}/teams/{team_slug}/members": {
+ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
"get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "summary": "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/list-members-in-org",
+ "operationId": "teams/check-permissions-for-repo-in-org",
"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/teams/teams#check-team-permissions-for-a-repository"
},
"parameters": [
{
@@ -253177,175 +252956,705 @@
}
},
{
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "default": 30
+ "type": "string"
}
},
{
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
+ "name": "repo",
+ "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "default": 1
+ "type": "string"
}
}
],
"responses": {
"200": {
- "description": "Response",
+ "description": "Alternative response with repository permissions",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
+ "title": "Team Repository",
+ "description": "A team's access to a repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the repository",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "description": "The name of the repository.",
+ "type": "string",
+ "example": "Team Environment"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "license": {
+ "title": "License Simple",
+ "description": "License Simple",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit"
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
},
- "site_admin": {
- "type": "boolean"
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ],
+ "nullable": true
+ },
+ "forks": {
+ "type": "integer"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ }
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
+ "role_name": {
+ "type": "string",
+ "example": "admin"
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ],
+ "nullable": true
+ },
+ "private": {
+ "description": "Whether the repository is private or public.",
+ "default": false,
+ "type": "boolean"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat/Hello-World"
+ },
+ "description": {
+ "type": "string",
+ "example": "This your first repo!",
+ "nullable": true
+ },
+ "fork": {
+ "type": "boolean"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/repos/octocat/Hello-World"
+ },
+ "archive_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ },
+ "assignees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ },
+ "blobs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ },
+ "branches_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ },
+ "collaborators_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ },
+ "comments_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ },
+ "commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ },
+ "compare_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ },
+ "contents_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/events"
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/forks"
+ },
+ "git_commits_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ },
+ "git_refs_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ },
+ "git_tags_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ },
+ "git_url": {
+ "type": "string",
+ "example": "git:github.com/octocat/Hello-World.git"
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ },
+ "issue_events_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ },
+ "issues_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ },
+ "keys_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ },
+ "labels_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/languages"
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/merges"
+ },
+ "milestones_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ },
+ "notifications_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ },
+ "pulls_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ },
+ "releases_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ },
+ "ssh_url": {
+ "type": "string",
+ "example": "git@github.com:octocat/Hello-World.git"
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
+ },
+ "statuses_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/tags"
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/teams"
+ },
+ "trees_url": {
+ "type": "string",
+ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ },
+ "clone_url": {
+ "type": "string",
+ "example": "https://github.com/octocat/Hello-World.git"
+ },
+ "mirror_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "git:git.example.com/octocat/Hello-World",
+ "nullable": true
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
+ },
+ "svn_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://svn.github.com/octocat/Hello-World"
+ },
+ "homepage": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "nullable": true
+ },
+ "forks_count": {
+ "type": "integer",
+ "example": 9
+ },
+ "stargazers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "watchers_count": {
+ "type": "integer",
+ "example": 80
+ },
+ "size": {
+ "type": "integer",
+ "example": 108
+ },
+ "default_branch": {
+ "description": "The default branch of the repository.",
+ "type": "string",
+ "example": "master"
+ },
+ "open_issues_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "is_template": {
+ "description": "Whether this repository acts as a template that can be used to generate new repositories.",
+ "default": false,
+ "type": "boolean",
+ "example": true
+ },
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
}
},
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
+ "has_issues": {
+ "description": "Whether issues are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_projects": {
+ "description": "Whether projects are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_wiki": {
+ "description": "Whether the wiki is enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_pages": {
+ "type": "boolean"
+ },
+ "has_downloads": {
+ "description": "Whether downloads are enabled.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "archived": {
+ "description": "Whether the repository is archived.",
+ "default": false,
+ "type": "boolean"
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "Returns whether or not this repository disabled."
+ },
+ "visibility": {
+ "description": "The repository visibility: public, private, or internal.",
+ "default": "public",
+ "type": "string"
+ },
+ "pushed_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:06:43Z",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:01:12Z",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2011-01-26T19:14:43Z",
+ "nullable": true
+ },
+ "allow_rebase_merge": {
+ "description": "Whether to allow rebase merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "temp_clone_token": {
+ "type": "string"
+ },
+ "allow_squash_merge": {
+ "description": "Whether to allow squash merges for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_auto_merge": {
+ "description": "Whether to allow Auto-merge to be used on pull requests.",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "delete_branch_on_merge": {
+ "description": "Whether to delete head branches when pull requests are merged",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "allow_merge_commit": {
+ "description": "Whether to allow merge commits for pull requests.",
+ "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "allow_forking": {
+ "description": "Whether to allow forking this repo",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "web_commit_signoff_required": {
+ "description": "Whether to require contributors to sign off on web-based commits",
+ "default": false,
+ "type": "boolean",
+ "example": false
+ },
+ "subscribers_count": {
+ "type": "integer"
+ },
+ "network_count": {
+ "type": "integer"
+ },
+ "open_issues": {
+ "type": "integer"
+ },
+ "watchers": {
+ "type": "integer"
+ },
+ "master_branch": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
+ "events_url",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
+ "html_url",
+ "id",
+ "node_id",
+ "issue_comment_url",
+ "issue_events_url",
+ "issues_url",
+ "keys_url",
+ "labels_url",
+ "languages_url",
+ "merges_url",
+ "milestones_url",
+ "name",
+ "notifications_url",
+ "owner",
+ "private",
+ "pulls_url",
+ "releases_url",
+ "stargazers_url",
+ "statuses_url",
+ "subscribers_url",
+ "subscription_url",
+ "tags_url",
+ "teams_url",
+ "trees_url",
+ "url",
+ "clone_url",
+ "default_branch",
+ "forks",
+ "forks_count",
+ "git_url",
+ "has_downloads",
+ "has_issues",
+ "has_projects",
+ "has_wiki",
+ "has_pages",
+ "homepage",
+ "language",
+ "archived",
+ "disabled",
+ "mirror_url",
+ "open_issues",
+ "open_issues_count",
+ "license",
+ "pushed_at",
+ "size",
+ "ssh_url",
+ "stargazers_count",
+ "svn_url",
+ "watchers",
+ "watchers_count",
+ "created_at",
+ "updated_at"
+ ]
},
"examples": {
- "default": {
- "value": [
- {
+ "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=",
@@ -253364,41 +253673,136 @@
"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
+ }
}
}
}
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
}
+ },
+ "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": "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/enterprise-cloud@latest//rest/teams/teams#create-a-team).",
+ },
+ "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/get-membership-for-user-in-org",
+ "operationId": "teams/add-or-update-repo-permissions-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions"
},
"parameters": [
{
@@ -253420,8 +253824,17 @@
}
},
{
- "name": "username",
- "description": "The handle for the GitHub user account.",
+ "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": {
@@ -253429,79 +253842,52 @@
}
}
],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
+ "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"
}
}
}
}
- },
- "404": {
- "description": "if user has no team membership"
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Response"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "members"
+ "subcategory": "teams"
}
},
- "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}`.",
+ "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/add-or-update-membership-for-user-in-org",
+ "operationId": "teams/remove-repo-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team"
},
"parameters": [
{
@@ -253523,8 +253909,17 @@
}
},
{
- "name": "username",
- "description": "The handle for the GitHub user account.",
+ "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": {
@@ -253532,111 +253927,154 @@
}
}
],
- "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": {
+ "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": "Team Membership",
- "description": "Team Membership",
+ "title": "GroupMapping",
+ "description": "External Groups to be mapped to a team for membership",
"type": "object",
"properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
+ "groups": {
+ "description": "Array of groups to be mapped to this team",
+ "example": [
+ {
+ "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"
+ }
],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "group_description"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The ID of the group",
+ "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
+ "type": "string"
+ },
+ "group_name": {
+ "description": "The name of the group",
+ "example": "saml-azuread-test",
+ "type": "string"
+ },
+ "group_description": {
+ "description": "a description of the group",
+ "example": "A group of Developers working on AzureAD SAML SSO",
+ "type": "string"
+ },
+ "status": {
+ "description": "synchronization status for this group mapping",
+ "example": "unsynced",
+ "type": "string"
+ },
+ "synced_at": {
+ "description": "the time of the last sync for this group-mapping",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
}
- },
- "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",
+ "default": {
"value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "member",
- "state": "pending"
+ "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."
+ }
+ ]
}
}
}
}
}
- },
- "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,
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
"category": "teams",
- "subcategory": "members"
+ "subcategory": "team-sync"
}
},
- "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}`.",
+ "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/remove-membership-for-user-in-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/members#remove-team-membership-for-a-user"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections"
},
"parameters": [
{
@@ -253656,44 +254094,165 @@
"schema": {
"type": "string"
}
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "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": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
+ "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",
+ "example": [
+ {
+ "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"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "group_description"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The ID of the group",
+ "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
+ "type": "string"
+ },
+ "group_name": {
+ "description": "The name of the group",
+ "example": "saml-azuread-test",
+ "type": "string"
+ },
+ "group_description": {
+ "description": "a description of the group",
+ "example": "A group of Developers working on AzureAD SAML SSO",
+ "type": "string"
+ },
+ "status": {
+ "description": "synchronization status for this group mapping",
+ "example": "unsynced",
+ "type": "string"
+ },
+ "synced_at": {
+ "description": "the time of the last sync for this group-mapping",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": false,
- "enabledForGitHubApps": true,
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
"category": "teams",
- "subcategory": "members"
+ "subcategory": "team-sync"
}
}
},
- "/orgs/{org}/teams/{team_slug}/repos": {
+ "/orgs/{org}/teams/{team_slug}/teams": {
"get": {
- "summary": "List team repositories",
- "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
+ "summary": "List child teams",
+ "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.",
"tags": [
"teams"
],
- "operationId": "teams/list-repos-in-org",
+ "operationId": "teams/list-child-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams"
},
"parameters": [
{
@@ -253735,824 +254294,252 @@
],
"responses": {
"200": {
- "description": "Response",
+ "description": "if child teams exist",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
- "title": "Minimal Repository",
- "description": "Minimal Repository",
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
"id": {
- "type": "integer",
- "format": "int64",
- "example": 1296269
+ "type": "integer"
},
"node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "type": "string",
- "example": "Hello-World"
- },
- "full_name": {
- "type": "string",
- "example": "octocat/Hello-World"
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
- },
- "description": {
- "type": "string",
- "example": "This your first repo!",
- "nullable": true
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- },
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- },
- "git_url": {
"type": "string"
},
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- },
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- },
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- },
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
+ "name": {
"type": "string"
},
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
- },
- "trees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
- },
- "clone_url": {
+ "slug": {
"type": "string"
},
- "mirror_url": {
+ "description": {
"type": "string",
"nullable": true
},
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
- },
- "svn_url": {
+ "privacy": {
"type": "string"
},
- "homepage": {
- "type": "string",
- "nullable": true
- },
- "language": {
- "type": "string",
- "nullable": true
- },
- "forks_count": {
- "type": "integer"
- },
- "stargazers_count": {
- "type": "integer"
- },
- "watchers_count": {
- "type": "integer"
- },
- "size": {
- "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
- "type": "integer"
- },
- "default_branch": {
+ "notification_setting": {
"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": {
+ "permission": {
"type": "string"
},
- "pushed_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:06:43Z",
- "nullable": true
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:01:12Z",
- "nullable": true
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:14:43Z",
- "nullable": true
- },
"permissions": {
"type": "object",
"properties": {
- "admin": {
+ "pull": {
"type": "boolean"
},
- "maintain": {
+ "triage": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
- "triage": {
+ "maintain": {
"type": "boolean"
},
- "pull": {
+ "admin": {
"type": "boolean"
}
- }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
},
- "role_name": {
+ "url": {
"type": "string",
- "example": "admin"
+ "format": "uri"
},
- "temp_clone_token": {
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "members_url": {
"type": "string"
},
- "delete_branch_on_merge": {
- "type": "boolean"
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
},
- "subscribers_count": {
- "type": "integer"
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "network_count": {
- "type": "integer"
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "code_of_conduct": {
- "title": "Code Of Conduct",
- "description": "Code Of Conduct",
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "key": {
- "type": "string",
- "example": "contributor_covenant"
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "example": 1
},
- "name": {
+ "node_id": {
"type": "string",
- "example": "Contributor Covenant"
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "body": {
+ "members_url": {
"type": "string",
- "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "html_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "nullable": true
- }
- },
- "required": [
- "url",
- "html_url",
- "key",
- "name"
- ]
- },
- "license": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
+ "example": "Justice League"
},
- "name": {
- "type": "string"
+ "description": {
+ "description": "Description of the team",
+ "type": "string",
+ "nullable": true,
+ "example": "A great team."
},
- "spdx_id": {
- "type": "string"
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "example": "admin"
},
- "url": {
- "type": "string"
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "example": "closed"
},
- "node_id": {
- "type": "string"
- }
- },
- "nullable": true
- },
- "forks": {
- "type": "integer",
- "example": 0
- },
- "open_issues": {
- "type": "integer",
- "example": 0
- },
- "watchers": {
- "type": "integer",
- "example": 0
- },
- "allow_forking": {
- "type": "boolean"
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "security_and_analysis": {
- "nullable": true,
- "type": "object",
- "properties": {
- "advanced_security": {
- "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n",
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "example": "notifications_enabled"
},
- "code_security": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "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"
- ]
- }
- }
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "secret_scanning": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
},
- "secret_scanning_push_protection": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
- "secret_scanning_non_provider_patterns": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "secret_scanning_ai_detection": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "secret_scanning_validity_checks": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "enabled",
- "disabled"
- ]
- }
- }
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
- }
- },
- "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": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
+ ],
+ "nullable": 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",
+ "url",
+ "members_url",
"name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url"
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent",
+ "type"
]
}
},
"examples": {
- "default": {
+ "response-if-child-teams-exist": {
"value": [
{
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
- "login": "octocat",
+ "id": 2,
+ "node_id": "MDQ6VGVhbTI=",
+ "url": "https://api.github.com/teams/2",
+ "name": "Original Roster",
+ "slug": "original-roster",
+ "description": "Started it all.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/2/members{/member}",
+ "repositories_url": "https://api.github.com/teams/2/repos",
+ "parent": {
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "private": false,
- "html_url": "https://github.com/octocat/Hello-World",
- "description": "This your first repo!",
- "fork": false,
- "url": "https://api.github.com/repos/octocat/Hello-World",
- "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
- "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
- "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
- "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
- "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
- "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
- "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
- "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
- "git_url": "git:github.com/octocat/Hello-World.git",
- "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
- "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
- "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
- "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
- "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
- "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
- "ssh_url": "git@github.com:octocat/Hello-World.git",
- "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
- "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
- "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
- "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
- "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
- "clone_url": "https://github.com/octocat/Hello-World.git",
- "mirror_url": "git:git.example.com/octocat/Hello-World",
- "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
- "svn_url": "https://svn.github.com/octocat/Hello-World",
- "homepage": "https://github.com",
- "language": null,
- "forks_count": 9,
- "stargazers_count": 80,
- "watchers_count": 80,
- "size": 108,
- "default_branch": "master",
- "open_issues_count": 0,
- "is_template": false,
- "topics": [
- "octocat",
- "atom",
- "electron",
- "api"
- ],
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true,
- "has_pages": false,
- "has_downloads": true,
- "has_discussions": false,
- "archived": false,
- "disabled": false,
- "visibility": "public",
- "pushed_at": "2011-01-26T19:06:43Z",
- "created_at": "2011-01-26T19:01:12Z",
- "updated_at": "2011-01-26T19:14:43Z",
- "permissions": {
- "admin": false,
- "push": false,
- "pull": true
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos"
},
- "security_and_analysis": {
- "advanced_security": {
- "status": "enabled"
- },
- "secret_scanning": {
- "status": "enabled"
- },
- "secret_scanning_push_protection": {
- "status": "disabled"
- },
- "secret_scanning_validity_checks": {
- "status": "disabled"
- }
- }
+ "html_url": "https://github.com/orgs/rails/teams/core"
}
]
}
@@ -254577,17 +254564,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": {
- "get": {
- "summary": "Check team permissions for a repository",
- "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-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}`.",
+ "/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/check-permissions-for-repo-in-org",
+ "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization"
},
"parameters": [
{
@@ -254600,14 +254587,586 @@
}
},
{
- "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": "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.",
@@ -254629,106 +255188,31 @@
],
"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",
- "example": 42,
- "type": "integer"
+ "type": "integer",
+ "format": "int64",
+ "example": 1296269
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"name": {
- "description": "The name of the repository.",
"type": "string",
- "example": "Team Environment"
+ "example": "Hello-World"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
- "license": {
- "title": "License Simple",
- "description": "License Simple",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "example": "mit"
- },
- "name": {
- "type": "string",
- "example": "MIT License"
- },
- "url": {
- "type": "string",
- "nullable": true,
- "format": "uri",
- "example": "https://api.github.com/licenses/mit"
- },
- "spdx_id": {
- "type": "string",
- "nullable": true,
- "example": "MIT"
- },
- "node_id": {
- "type": "string",
- "example": "MDc6TGljZW5zZW1pdA=="
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "key",
- "name",
- "url",
- "spdx_id",
- "node_id"
- ],
- "nullable": true
- },
- "forks": {
- "type": "integer"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- }
- },
- "required": [
- "admin",
- "pull",
- "push"
- ]
- },
- "role_name": {
- "type": "string",
- "example": "admin"
- },
"owner": {
"title": "Simple User",
"description": "A GitHub user.",
@@ -254851,12 +255335,9 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
+ ]
},
"private": {
- "description": "Whether the repository is private or public.",
- "default": false,
"type": "boolean"
},
"html_url": {
@@ -255080,11 +255561,11 @@
"example": 80
},
"size": {
+ "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
"type": "integer",
"example": 108
},
"default_branch": {
- "description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
@@ -255093,8 +255574,6 @@
"example": 0
},
"is_template": {
- "description": "Whether this repository acts as a template that can be used to generate new repositories.",
- "default": false,
"type": "boolean",
"example": true
},
@@ -255102,23 +255581,23 @@
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "example": [
+ "octocat",
+ "atom",
+ "electron",
+ "API"
+ ]
},
"has_issues": {
- "description": "Whether issues are enabled.",
- "default": true,
"type": "boolean",
"example": true
},
"has_projects": {
- "description": "Whether projects are enabled.",
- "default": true,
"type": "boolean",
"example": true
},
"has_wiki": {
- "description": "Whether the wiki is enabled.",
- "default": true,
"type": "boolean",
"example": true
},
@@ -255126,14 +255605,14 @@
"type": "boolean"
},
"has_downloads": {
- "description": "Whether downloads are enabled.",
- "default": true,
+ "type": "boolean",
+ "example": true
+ },
+ "has_discussions": {
"type": "boolean",
"example": true
},
"archived": {
- "description": "Whether the repository is archived.",
- "default": false,
"type": "boolean"
},
"disabled": {
@@ -255142,2182 +255621,50 @@
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
- "default": "public",
- "type": "string"
+ "type": "string",
+ "example": "public"
},
"pushed_at": {
"type": "string",
"format": "date-time",
- "example": "2011-01-26T19:06:43Z",
- "nullable": true
+ "example": "2011-01-26T19:06:43Z"
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2011-01-26T19:01:12Z",
- "nullable": true
+ "example": "2011-01-26T19:01:12Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2011-01-26T19:14:43Z",
- "nullable": true
- },
- "allow_rebase_merge": {
- "description": "Whether to allow rebase merges for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "temp_clone_token": {
- "type": "string"
- },
- "allow_squash_merge": {
- "description": "Whether to allow squash merges for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "allow_auto_merge": {
- "description": "Whether to allow Auto-merge to be used on pull requests.",
- "default": false,
- "type": "boolean",
- "example": false
+ "example": "2011-01-26T19:14:43Z"
},
- "delete_branch_on_merge": {
- "description": "Whether to delete head branches when pull requests are merged",
- "default": false,
- "type": "boolean",
- "example": false
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
},
- "allow_merge_commit": {
- "description": "Whether to allow merge commits for pull requests.",
- "default": true,
- "type": "boolean",
- "example": true
- },
- "allow_forking": {
- "description": "Whether to allow forking this repo",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "web_commit_signoff_required": {
- "description": "Whether to require contributors to sign off on web-based commits",
- "default": false,
- "type": "boolean",
- "example": false
- },
- "subscribers_count": {
- "type": "integer"
- },
- "network_count": {
- "type": "integer"
- },
- "open_issues": {
- "type": "integer"
- },
- "watchers": {
- "type": "integer"
- },
- "master_branch": {
- "type": "string"
- }
- },
- "required": [
- "archive_url",
- "assignees_url",
- "blobs_url",
- "branches_url",
- "collaborators_url",
- "comments_url",
- "commits_url",
- "compare_url",
- "contents_url",
- "contributors_url",
- "deployments_url",
- "description",
- "downloads_url",
- "events_url",
- "fork",
- "forks_url",
- "full_name",
- "git_commits_url",
- "git_refs_url",
- "git_tags_url",
- "hooks_url",
- "html_url",
- "id",
- "node_id",
- "issue_comment_url",
- "issue_events_url",
- "issues_url",
- "keys_url",
- "labels_url",
- "languages_url",
- "merges_url",
- "milestones_url",
- "name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url",
- "clone_url",
- "default_branch",
- "forks",
- "forks_count",
- "git_url",
- "has_downloads",
- "has_issues",
- "has_projects",
- "has_wiki",
- "has_pages",
- "homepage",
- "language",
- "archived",
- "disabled",
- "mirror_url",
- "open_issues",
- "open_issues_count",
- "license",
- "pushed_at",
- "size",
- "ssh_url",
- "stargazers_count",
- "svn_url",
- "watchers",
- "watchers_count",
- "created_at",
- "updated_at"
- ]
- },
- "examples": {
- "alternative-response-with-repository-permissions": {
- "value": {
- "id": 1296269,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
- "name": "Hello-World",
- "full_name": "octocat/Hello-World",
- "owner": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "private": false,
- "html_url": "https://github.com/octocat/Hello-World",
- "description": "This your first repo!",
- "fork": false,
- "url": "https://api.github.com/repos/octocat/Hello-World",
- "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
- "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
- "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
- "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
- "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
- "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
- "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
- "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
- "git_url": "git:github.com/octocat/Hello-World.git",
- "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
- "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
- "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
- "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
- "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
- "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
- "ssh_url": "git@github.com:octocat/Hello-World.git",
- "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
- "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
- "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
- "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
- "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
- "clone_url": "https://github.com/octocat/Hello-World.git",
- "mirror_url": "git:git.example.com/octocat/Hello-World",
- "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
- "svn_url": "https://svn.github.com/octocat/Hello-World",
- "homepage": "https://github.com",
- "language": null,
- "forks_count": 9,
- "stargazers_count": 80,
- "watchers_count": 80,
- "size": 108,
- "default_branch": "master",
- "open_issues_count": 0,
- "is_template": false,
- "topics": [
- "octocat",
- "atom",
- "electron",
- "api"
- ],
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true,
- "has_pages": false,
- "has_downloads": true,
- "archived": false,
- "disabled": false,
- "visibility": "public",
- "pushed_at": "2011-01-26T19:06:43Z",
- "created_at": "2011-01-26T19:01:12Z",
- "updated_at": "2011-01-26T19:14:43Z",
- "permissions": {
- "admin": false,
- "maintain": false,
- "push": false,
- "triage": false,
- "pull": true
- },
- "role_name": "read",
- "allow_rebase_merge": true,
- "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
- "allow_squash_merge": true,
- "allow_auto_merge": false,
- "delete_branch_on_merge": true,
- "allow_merge_commit": true,
- "subscribers_count": 42,
- "network_count": 0,
- "license": {
- "key": "mit",
- "name": "MIT License",
- "url": "https://api.github.com/licenses/mit",
- "spdx_id": "MIT",
- "node_id": "MDc6TGljZW5zZW1pdA==",
- "html_url": "https://api.github.com/licenses/mit"
- },
- "forks": 1,
- "open_issues": 1,
- "watchers": 1
- }
- }
- }
- }
- }
- },
- "204": {
- "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header."
- },
- "404": {
- "description": "Not Found if team does not have permission for the repository"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams"
- }
- },
- "put": {
- "summary": "Add or update team repository permissions",
- "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/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",
- "example": [
- {
- "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"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "group_description"
- ],
- "properties": {
- "group_id": {
- "description": "The ID of the group",
- "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
- "type": "string"
- },
- "group_name": {
- "description": "The name of the group",
- "example": "saml-azuread-test",
- "type": "string"
- },
- "group_description": {
- "description": "a description of the group",
- "example": "A group of Developers working on AzureAD SAML SSO",
- "type": "string"
- },
- "status": {
- "description": "synchronization status for this group mapping",
- "example": "unsynced",
- "type": "string"
- },
- "synced_at": {
- "description": "the time of the last sync for this group-mapping",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string",
- "nullable": true
- }
- }
- }
- }
- }
- },
- "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",
- "example": [
- {
- "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"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "group_description"
- ],
- "properties": {
- "group_id": {
- "description": "The ID of the group",
- "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa",
- "type": "string"
- },
- "group_name": {
- "description": "The name of the group",
- "example": "saml-azuread-test",
- "type": "string"
- },
- "group_description": {
- "description": "a description of the group",
- "example": "A group of Developers working on AzureAD SAML SSO",
- "type": "string"
- },
- "status": {
- "description": "synchronization status for this group mapping",
- "example": "unsynced",
- "type": "string"
- },
- "synced_at": {
- "description": "the time of the last sync for this group-mapping",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string",
- "nullable": true
- }
- }
- }
- }
- }
- },
- "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",
- "nullable": true
- },
- "privacy": {
- "type": "string"
- },
- "notification_setting": {
- "type": "string"
- },
- "permission": {
- "type": "string"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "pull",
- "triage",
- "push",
- "maintain",
- "admin"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "members_url": {
- "type": "string"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- }
- },
- "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",
- "example": 1296269
- },
- "node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "type": "string",
- "example": "Hello-World"
- },
- "full_name": {
- "type": "string",
- "example": "octocat/Hello-World"
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "private": {
- "type": "boolean"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat/Hello-World"
- },
- "description": {
- "type": "string",
- "example": "This your first repo!",
- "nullable": true
- },
- "fork": {
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/repos/octocat/Hello-World"
- },
- "archive_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
- },
- "assignees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
- },
- "blobs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
- },
- "branches_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
- },
- "collaborators_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
- },
- "comments_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
- },
- "commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
- },
- "compare_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
- },
- "contents_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
- },
- "contributors_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
- },
- "deployments_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
- },
- "downloads_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/events"
- },
- "forks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/forks"
- },
- "git_commits_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
- },
- "git_refs_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
- },
- "git_tags_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
- },
- "git_url": {
- "type": "string",
- "example": "git:github.com/octocat/Hello-World.git"
- },
- "issue_comment_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
- },
- "issue_events_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
- },
- "issues_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
- },
- "keys_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
- },
- "labels_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
- },
- "languages_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/languages"
- },
- "merges_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/merges"
- },
- "milestones_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
- },
- "notifications_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
- },
- "pulls_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
- },
- "releases_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
- },
- "ssh_url": {
- "type": "string",
- "example": "git@github.com:octocat/Hello-World.git"
- },
- "stargazers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
- },
- "statuses_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
- },
- "subscribers_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
- },
- "subscription_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
- },
- "tags_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/tags"
- },
- "teams_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/teams"
- },
- "trees_url": {
- "type": "string",
- "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
- },
- "clone_url": {
- "type": "string",
- "example": "https://github.com/octocat/Hello-World.git"
- },
- "mirror_url": {
- "type": "string",
- "format": "uri",
- "example": "git:git.example.com/octocat/Hello-World",
- "nullable": true
- },
- "hooks_url": {
- "type": "string",
- "format": "uri",
- "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
- },
- "svn_url": {
- "type": "string",
- "format": "uri",
- "example": "https://svn.github.com/octocat/Hello-World"
- },
- "homepage": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com",
- "nullable": true
- },
- "language": {
- "type": "string",
- "nullable": true
- },
- "forks_count": {
- "type": "integer",
- "example": 9
- },
- "stargazers_count": {
- "type": "integer",
- "example": 80
- },
- "watchers_count": {
- "type": "integer",
- "example": 80
- },
- "size": {
- "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
- "type": "integer",
- "example": 108
- },
- "default_branch": {
- "type": "string",
- "example": "master"
- },
- "open_issues_count": {
- "type": "integer",
- "example": 0
- },
- "is_template": {
- "type": "boolean",
- "example": true
- },
- "topics": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "octocat",
- "atom",
- "electron",
- "API"
- ]
- },
- "has_issues": {
- "type": "boolean",
- "example": true
- },
- "has_projects": {
- "type": "boolean",
- "example": true
- },
- "has_wiki": {
- "type": "boolean",
- "example": true
- },
- "has_pages": {
- "type": "boolean"
- },
- "has_downloads": {
- "type": "boolean",
- "example": true
- },
- "has_discussions": {
- "type": "boolean",
- "example": true
- },
- "archived": {
- "type": "boolean"
- },
- "disabled": {
- "type": "boolean",
- "description": "Returns whether or not this repository disabled."
- },
- "visibility": {
- "description": "The repository visibility: public, private, or internal.",
- "type": "string",
- "example": "public"
- },
- "pushed_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:06:43Z"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:01:12Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2011-01-26T19:14:43Z"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- },
- "required": [
- "admin",
- "pull",
- "push"
- ]
- },
- "allow_rebase_merge": {
+ "allow_rebase_merge": {
"type": "boolean",
"example": true
},
@@ -593078,1068 +591425,170 @@
"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",
- "format": "uri",
- "nullable": true
- },
- "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": {
- "title": "License Simple",
- "description": "License Simple",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "example": "mit"
- },
- "name": {
- "type": "string",
- "example": "MIT License"
- },
- "url": {
- "type": "string",
- "nullable": true,
- "format": "uri",
- "example": "https://api.github.com/licenses/mit"
- },
- "spdx_id": {
- "type": "string",
- "nullable": true,
- "example": "MIT"
- },
- "node_id": {
- "type": "string",
- "example": "MDc6TGljZW5zZW1pdA=="
- },
- "html_url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "key",
- "name",
- "url",
- "spdx_id",
- "node_id"
- ],
- "nullable": true
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- },
- "required": [
- "admin",
- "pull",
- "push"
- ]
- },
- "text_matches": {
- "title": "Search Result Text Matches",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "object_url": {
- "type": "string"
- },
- "object_type": {
- "nullable": true,
- "type": "string"
- },
- "property": {
- "type": "string"
- },
- "fragment": {
- "type": "string"
- },
- "matches": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- },
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- }
- }
- }
- }
- },
- "temp_clone_token": {
- "type": "string"
- },
- "allow_merge_commit": {
- "type": "boolean"
- },
- "allow_squash_merge": {
- "type": "boolean"
- },
- "allow_rebase_merge": {
- "type": "boolean"
- },
- "allow_auto_merge": {
- "type": "boolean"
- },
- "delete_branch_on_merge": {
- "type": "boolean"
- },
- "allow_forking": {
- "type": "boolean"
- },
- "is_template": {
- "type": "boolean"
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- }
- },
- "required": [
- "archive_url",
- "assignees_url",
- "blobs_url",
- "branches_url",
- "collaborators_url",
- "comments_url",
- "commits_url",
- "compare_url",
- "contents_url",
- "contributors_url",
- "deployments_url",
- "description",
- "downloads_url",
- "events_url",
- "fork",
- "forks_url",
- "full_name",
- "git_commits_url",
- "git_refs_url",
- "git_tags_url",
- "hooks_url",
- "html_url",
- "id",
- "node_id",
- "issue_comment_url",
- "issue_events_url",
- "issues_url",
- "keys_url",
- "labels_url",
- "languages_url",
- "merges_url",
- "milestones_url",
- "name",
- "notifications_url",
- "owner",
- "private",
- "pulls_url",
- "releases_url",
- "stargazers_url",
- "statuses_url",
- "subscribers_url",
- "subscription_url",
- "tags_url",
- "teams_url",
- "trees_url",
- "url",
- "clone_url",
- "default_branch",
- "forks",
- "forks_count",
- "git_url",
- "has_downloads",
- "has_issues",
- "has_projects",
- "has_wiki",
- "has_pages",
- "homepage",
- "language",
- "archived",
- "disabled",
- "mirror_url",
- "open_issues",
- "open_issues_count",
- "license",
- "pushed_at",
- "size",
- "ssh_url",
- "stargazers_count",
- "svn_url",
- "watchers",
- "watchers_count",
- "created_at",
- "updated_at",
- "score"
- ]
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "total_count": 40,
- "incomplete_results": false,
- "items": [
- {
- "id": 3081286,
- "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2",
- "name": "Tetris",
- "full_name": "dtrupenn/Tetris",
- "owner": {
- "login": "dtrupenn",
- "id": 872147,
- "node_id": "MDQ6VXNlcjg3MjE0Nw==",
- "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
- "gravatar_id": "",
- "url": "https://api.github.com/users/dtrupenn",
- "received_events_url": "https://api.github.com/users/dtrupenn/received_events",
- "type": "User",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "site_admin": true
- },
- "private": false,
- "html_url": "https://github.com/dtrupenn/Tetris",
- "description": "A C implementation of Tetris using Pennsim through LC4",
- "fork": false,
- "url": "https://api.github.com/repos/dtrupenn/Tetris",
- "created_at": "2012-01-01T00:31:50Z",
- "updated_at": "2013-01-05T17:58:47Z",
- "pushed_at": "2012-01-01T00:37:02Z",
- "homepage": "https://github.com",
- "size": 524,
- "stargazers_count": 1,
- "watchers_count": 1,
- "language": "Assembly",
- "forks_count": 0,
- "open_issues_count": 0,
- "master_branch": "master",
- "default_branch": "master",
- "score": 1,
- "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}",
- "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}",
- "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}",
- "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}",
- "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}",
- "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}",
- "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}",
- "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}",
- "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}",
- "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors",
- "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments",
- "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads",
- "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events",
- "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks",
- "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}",
- "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}",
- "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}",
- "git_url": "git:github.com/dtrupenn/Tetris.git",
- "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}",
- "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}",
- "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}",
- "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}",
- "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}",
- "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages",
- "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges",
- "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}",
- "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}",
- "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}",
- "ssh_url": "git@github.com:dtrupenn/Tetris.git",
- "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers",
- "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}",
- "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers",
- "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription",
- "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags",
- "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams",
- "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}",
- "clone_url": "https://github.com/dtrupenn/Tetris.git",
- "mirror_url": "git:git.example.com/dtrupenn/Tetris",
- "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks",
- "svn_url": "https://svn.github.com/dtrupenn/Tetris",
- "forks": 1,
- "open_issues": 1,
- "watchers": 1,
- "has_issues": true,
- "has_projects": true,
- "has_pages": true,
- "has_wiki": true,
- "has_downloads": true,
- "archived": true,
- "disabled": true,
- "visibility": "private",
- "license": {
- "key": "mit",
- "name": "MIT License",
- "url": "https://api.github.com/licenses/mit",
- "spdx_id": "MIT",
- "node_id": "MDc6TGljZW5zZW1pdA==",
- "html_url": "https://api.github.com/licenses/mit"
- }
- }
- ]
- }
- }
- }
- }
- }
- },
- "503": {
- "description": "Service unavailable",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "search",
- "subcategory": "search"
- }
- }
- },
- "/search/topics": {
- "get": {
- "summary": "Search topics",
- "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/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",
- "nullable": true
- },
- "short_description": {
- "type": "string",
- "nullable": true
- },
- "description": {
- "type": "string",
- "nullable": true
- },
- "created_by": {
- "type": "string",
- "nullable": true
- },
- "released": {
- "type": "string",
- "nullable": true
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "featured": {
- "type": "boolean"
- },
- "curated": {
- "type": "boolean"
- },
- "score": {
- "type": "number"
- },
- "repository_count": {
- "type": "integer",
- "nullable": true
- },
- "logo_url": {
- "type": "string",
- "format": "uri",
- "nullable": true
- },
- "text_matches": {
- "title": "Search Result Text Matches",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "object_url": {
- "type": "string"
- },
- "object_type": {
- "nullable": true,
- "type": "string"
- },
- "property": {
- "type": "string"
- },
- "fragment": {
- "type": "string"
- },
- "matches": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- },
- "indices": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- }
- }
- }
- }
- },
- "related": {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "object",
- "properties": {
- "topic_relation": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "topic_id": {
- "type": "integer"
- },
- "relation_type": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "aliases": {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "object",
- "properties": {
- "topic_relation": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "topic_id": {
- "type": "integer"
- },
- "relation_type": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "required": [
- "name",
- "display_name",
- "short_description",
- "description",
- "created_by",
- "released",
- "created_at",
- "updated_at",
- "featured",
- "curated",
- "score"
- ]
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "total_count": 6,
- "incomplete_results": false,
- "items": [
- {
- "name": "ruby",
- "display_name": "Ruby",
- "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.",
- "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.",
- "created_by": "Yukihiro Matsumoto",
- "released": "December 21, 1995",
- "created_at": "2016-11-28T22:03:59Z",
- "updated_at": "2017-10-30T18:16:32Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "rails",
- "display_name": "Rails",
- "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.",
- "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.",
- "created_by": "David Heinemeier Hansson",
- "released": "December 13 2005",
- "created_at": "2016-12-09T17:03:50Z",
- "updated_at": "2017-10-30T16:20:19Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "python",
- "display_name": "Python",
- "short_description": "Python is a dynamically typed programming language.",
- "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.",
- "created_by": "Guido van Rossum",
- "released": "February 20, 1991",
- "created_at": "2016-12-07T00:07:02Z",
- "updated_at": "2017-10-27T22:45:43Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "jekyll",
- "display_name": "Jekyll",
- "short_description": "Jekyll is a simple, blog-aware static site generator.",
- "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.",
- "created_by": "Tom Preston-Werner",
- "released": "2008",
- "created_at": "2016-12-16T21:53:08Z",
- "updated_at": "2017-10-27T19:00:24Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "sass",
- "display_name": "Sass",
- "short_description": "Sass is a stable extension to classic CSS.",
- "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.",
- "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein",
- "released": "November 28, 2006",
- "created_at": "2016-12-16T21:53:45Z",
- "updated_at": "2018-01-16T16:30:40Z",
- "featured": true,
- "curated": true,
- "score": 1
- },
- {
- "name": "homebrew",
- "display_name": "Homebrew",
- "short_description": "Homebrew is a package manager for macOS.",
- "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.",
- "created_by": "Max Howell",
- "released": "2009",
- "created_at": "2016-12-17T20:30:44Z",
- "updated_at": "2018-02-06T16:14:56Z",
- "featured": true,
- "curated": true,
- "score": 1
- }
- ]
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "Not modified"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "search",
- "subcategory": "search"
- }
- }
- },
- "/search/users": {
- "get": {
- "summary": "Search users",
- "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/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",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri"
+ "type": "string"
},
- "html_url": {
+ "merges_url": {
"type": "string",
"format": "uri"
},
- "followers_url": {
- "type": "string",
- "format": "uri"
+ "archive_url": {
+ "type": "string"
},
- "subscriptions_url": {
+ "downloads_url": {
"type": "string",
"format": "uri"
},
- "organizations_url": {
- "type": "string",
- "format": "uri"
+ "issues_url": {
+ "type": "string"
},
- "repos_url": {
- "type": "string",
- "format": "uri"
+ "pulls_url": {
+ "type": "string"
},
- "received_events_url": {
- "type": "string",
- "format": "uri"
+ "milestones_url": {
+ "type": "string"
},
- "type": {
+ "notifications_url": {
"type": "string"
},
- "score": {
- "type": "number"
+ "labels_url": {
+ "type": "string"
},
- "following_url": {
+ "releases_url": {
"type": "string"
},
- "gists_url": {
+ "deployments_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "git_url": {
"type": "string"
},
- "starred_url": {
+ "ssh_url": {
"type": "string"
},
- "events_url": {
+ "clone_url": {
"type": "string"
},
- "public_repos": {
- "type": "integer"
+ "svn_url": {
+ "type": "string",
+ "format": "uri"
},
- "public_gists": {
+ "forks": {
"type": "integer"
},
- "followers": {
+ "open_issues": {
"type": "integer"
},
- "following": {
+ "watchers": {
"type": "integer"
},
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
+ "topics": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "name": {
+ "mirror_url": {
"type": "string",
+ "format": "uri",
"nullable": true
},
- "bio": {
- "type": "string",
- "nullable": true
+ "has_issues": {
+ "type": "boolean"
},
- "email": {
- "type": "string",
- "format": "email",
- "nullable": true
+ "has_projects": {
+ "type": "boolean"
},
- "location": {
- "type": "string",
- "nullable": true
+ "has_pages": {
+ "type": "boolean"
},
- "site_admin": {
+ "has_wiki": {
"type": "boolean"
},
- "hireable": {
+ "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": {
+ "title": "License Simple",
+ "description": "License Simple",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "example": "mit"
+ },
+ "name": {
+ "type": "string",
+ "example": "MIT License"
+ },
+ "url": {
+ "type": "string",
+ "nullable": true,
+ "format": "uri",
+ "example": "https://api.github.com/licenses/mit"
+ },
+ "spdx_id": {
+ "type": "string",
+ "nullable": true,
+ "example": "MIT"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDc6TGljZW5zZW1pdA=="
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "key",
+ "name",
+ "url",
+ "spdx_id",
+ "node_id"
+ ],
"nullable": true
},
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "admin": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "pull": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "admin",
+ "pull",
+ "push"
+ ]
+ },
"text_matches": {
"title": "Search Result Text Matches",
"type": "array",
@@ -594179,42 +591628,109 @@
}
}
},
- "blog": {
- "type": "string",
- "nullable": true
+ "temp_clone_token": {
+ "type": "string"
},
- "company": {
- "type": "string",
- "nullable": true
+ "allow_merge_commit": {
+ "type": "boolean"
},
- "suspended_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
+ "allow_squash_merge": {
+ "type": "boolean"
},
- "user_view_type": {
- "type": "string"
+ "allow_rebase_merge": {
+ "type": "boolean"
+ },
+ "allow_auto_merge": {
+ "type": "boolean"
+ },
+ "delete_branch_on_merge": {
+ "type": "boolean"
+ },
+ "allow_forking": {
+ "type": "boolean"
+ },
+ "is_template": {
+ "type": "boolean"
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
}
},
"required": [
- "avatar_url",
+ "archive_url",
+ "assignees_url",
+ "blobs_url",
+ "branches_url",
+ "collaborators_url",
+ "comments_url",
+ "commits_url",
+ "compare_url",
+ "contents_url",
+ "contributors_url",
+ "deployments_url",
+ "description",
+ "downloads_url",
"events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
+ "fork",
+ "forks_url",
+ "full_name",
+ "git_commits_url",
+ "git_refs_url",
+ "git_tags_url",
+ "hooks_url",
"html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
+ "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"
]
}
@@ -594224,29 +591740,112 @@
"examples": {
"default": {
"value": {
- "total_count": 12,
+ "total_count": 40,
"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",
+ "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,
- "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
+ "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"
+ }
}
]
}
@@ -594255,9 +591854,6 @@
}
}
},
- "304": {
- "description": "Not modified"
- },
"503": {
"description": "Service unavailable",
"content": {
@@ -594322,620 +591918,25 @@
"type": "integer"
},
"value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "search",
- "subcategory": "search"
- }
- }
- },
- "/teams/{team_id}": {
- "get": {
- "summary": "Get a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "parent": null,
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "is_verified": true,
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
@@ -594943,693 +591944,791 @@
}
}
},
- "404": {
- "description": "Resource not found",
+ "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": {
- "title": "Basic Error",
- "description": "Basic Error",
"type": "object",
+ "required": [
+ "total_count",
+ "incomplete_results",
+ "items"
+ ],
"properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
+ "total_count": {
+ "type": "integer"
},
- "url": {
- "type": "string"
+ "incomplete_results": {
+ "type": "boolean"
},
- "status": {
- "type": "string"
+ "items": {
+ "type": "array",
+ "items": {
+ "title": "Topic Search Result Item",
+ "description": "Topic Search Result Item",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "display_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "short_description": {
+ "type": "string",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_by": {
+ "type": "string",
+ "nullable": true
+ },
+ "released": {
+ "type": "string",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "featured": {
+ "type": "boolean"
+ },
+ "curated": {
+ "type": "boolean"
+ },
+ "score": {
+ "type": "number"
+ },
+ "repository_count": {
+ "type": "integer",
+ "nullable": true
+ },
+ "logo_url": {
+ "type": "string",
+ "format": "uri",
+ "nullable": true
+ },
+ "text_matches": {
+ "title": "Search Result Text Matches",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "object_url": {
+ "type": "string"
+ },
+ "object_type": {
+ "nullable": true,
+ "type": "string"
+ },
+ "property": {
+ "type": "string"
+ },
+ "fragment": {
+ "type": "string"
+ },
+ "matches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "related": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "topic_relation": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "topic_id": {
+ "type": "integer"
+ },
+ "relation_type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "aliases": {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "properties": {
+ "topic_relation": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "topic_id": {
+ "type": "integer"
+ },
+ "relation_type": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": [
+ "name",
+ "display_name",
+ "short_description",
+ "description",
+ "created_by",
+ "released",
+ "created_at",
+ "updated_at",
+ "featured",
+ "curated",
+ "score"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 6,
+ "incomplete_results": false,
+ "items": [
+ {
+ "name": "ruby",
+ "display_name": "Ruby",
+ "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.",
+ "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.",
+ "created_by": "Yukihiro Matsumoto",
+ "released": "December 21, 1995",
+ "created_at": "2016-11-28T22:03:59Z",
+ "updated_at": "2017-10-30T18:16:32Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "rails",
+ "display_name": "Rails",
+ "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.",
+ "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.",
+ "created_by": "David Heinemeier Hansson",
+ "released": "December 13 2005",
+ "created_at": "2016-12-09T17:03:50Z",
+ "updated_at": "2017-10-30T16:20:19Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "python",
+ "display_name": "Python",
+ "short_description": "Python is a dynamically typed programming language.",
+ "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.",
+ "created_by": "Guido van Rossum",
+ "released": "February 20, 1991",
+ "created_at": "2016-12-07T00:07:02Z",
+ "updated_at": "2017-10-27T22:45:43Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "jekyll",
+ "display_name": "Jekyll",
+ "short_description": "Jekyll is a simple, blog-aware static site generator.",
+ "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.",
+ "created_by": "Tom Preston-Werner",
+ "released": "2008",
+ "created_at": "2016-12-16T21:53:08Z",
+ "updated_at": "2017-10-27T19:00:24Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "sass",
+ "display_name": "Sass",
+ "short_description": "Sass is a stable extension to classic CSS.",
+ "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.",
+ "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein",
+ "released": "November 28, 2006",
+ "created_at": "2016-12-16T21:53:45Z",
+ "updated_at": "2018-01-16T16:30:40Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ },
+ {
+ "name": "homebrew",
+ "display_name": "Homebrew",
+ "short_description": "Homebrew is a package manager for macOS.",
+ "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.",
+ "created_by": "Max Howell",
+ "released": "2009",
+ "created_at": "2016-12-17T20:30:44Z",
+ "updated_at": "2018-02-06T16:14:56Z",
+ "featured": true,
+ "curated": true,
+ "score": 1
+ }
+ ]
}
}
}
}
}
+ },
+ "304": {
+ "description": "Not modified"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "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`.",
+ "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": [
- "teams"
+ "search"
],
- "operationId": "teams/update-legacy",
+ "operationId": "search/users",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-users"
},
"parameters": [
{
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
+ "name": "q",
+ "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub 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": "integer"
+ "type": "string"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the team."
- },
- "description": {
- "type": "string",
- "description": "The description of the team."
- },
- "privacy": {
- "type": "string",
- "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
- "enum": [
- "secret",
- "closed"
- ]
- },
- "notification_setting": {
- "type": "string",
- "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ]
- },
- "permission": {
- "type": "string",
- "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.",
- "enum": [
- "pull",
- "push",
- "admin"
- ],
- "default": "pull"
- },
- "parent_team_id": {
- "type": "integer",
- "description": "The ID of a team to set as the parent team.",
- "nullable": true
- }
- },
- "required": [
- "name"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed",
- "notification_setting": "notifications_enabled"
- }
- }
- }
+ },
+ {
+ "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 when the updated information already exists",
+ "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",
- "example": 42,
+ "total_count": {
"type": "integer"
},
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
+ "incomplete_results": {
+ "type": "boolean"
},
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
+ "items": {
+ "type": "array",
+ "items": {
+ "title": "User Search Result Item",
+ "description": "User Search Result Item",
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "type": {
+ "type": "string"
+ },
+ "score": {
+ "type": "number"
+ },
+ "following_url": {
+ "type": "string"
+ },
+ "gists_url": {
+ "type": "string"
+ },
+ "starred_url": {
+ "type": "string"
+ },
+ "events_url": {
+ "type": "string"
+ },
+ "public_repos": {
+ "type": "integer"
+ },
+ "public_gists": {
+ "type": "integer"
+ },
+ "followers": {
+ "type": "integer"
+ },
+ "following": {
+ "type": "integer"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "name": {
+ "type": "string",
+ "nullable": true
+ },
+ "bio": {
+ "type": "string",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "nullable": true
+ },
+ "location": {
+ "type": "string",
+ "nullable": true
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "hireable": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "text_matches": {
+ "title": "Search Result Text Matches",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "object_url": {
+ "type": "string"
+ },
+ "object_type": {
+ "nullable": true,
+ "type": "string"
+ },
+ "property": {
+ "type": "string"
+ },
+ "fragment": {
+ "type": "string"
+ },
+ "matches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string"
+ },
+ "indices": {
+ "type": "array",
+ "items": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ }
}
},
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
+ "blog": {
+ "type": "string",
+ "nullable": true
+ },
+ "company": {
+ "type": "string",
+ "nullable": true
+ },
+ "suspended_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "user_view_type": {
+ "type": "string"
+ }
},
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url",
+ "score"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "total_count": 12,
+ "incomplete_results": false,
+ "items": [
+ {
+ "login": "mojombo",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/mojombo",
+ "html_url": "https://github.com/mojombo",
+ "followers_url": "https://api.github.com/users/mojombo/followers",
+ "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
+ "organizations_url": "https://api.github.com/users/mojombo/orgs",
+ "repos_url": "https://api.github.com/users/mojombo/repos",
+ "received_events_url": "https://api.github.com/users/mojombo/received_events",
+ "type": "User",
+ "score": 1,
+ "following_url": "https://api.github.com/users/mojombo/following{/other_user}",
+ "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
+ "events_url": "https://api.github.com/users/mojombo/events{/privacy}",
+ "site_admin": true
}
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
]
+ }
+ }
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not modified"
+ },
+ "503": {
+ "description": "Service unavailable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
},
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
+ "message": {
+ "type": "string"
},
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
+ "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": [
- "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"
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
- },
- "201": {
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "search",
+ "subcategory": "search"
+ }
+ }
+ },
+ "/teams/{team_id}": {
+ "get": {
+ "summary": "Get a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-legacy",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy"
+ },
+ "parameters": [
+ {
+ "name": "team_id",
+ "description": "The unique identifier of the team.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
@@ -596060,792 +593159,159 @@
"type": "string",
"format": "date-time"
},
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "parent": null,
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "is_verified": true,
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "404": {
- "description": "Resource not found",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ }
+ },
+ "required": [
+ "login",
+ "url",
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
},
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
+ "updated_at",
+ "members_count",
+ "repos_count",
+ "organization"
+ ]
},
"examples": {
"default": {
- "value": [
- {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
+ "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"
}
- ]
+ }
}
}
}
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
"schema": {
- "type": "string"
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
}
}
}
@@ -596857,20 +593323,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"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.",
+ "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/create-discussion-legacy",
+ "operationId": "teams/update-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy"
},
"parameters": [
{
@@ -596890,30 +593356,57 @@
"schema": {
"type": "object",
"properties": {
- "title": {
+ "name": {
"type": "string",
- "description": "The discussion post's title."
+ "description": "The name of the team."
},
- "body": {
+ "description": {
"type": "string",
- "description": "The discussion post's body text."
+ "description": "The description of the team."
},
- "private": {
- "type": "boolean",
- "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
- "default": false
+ "privacy": {
+ "type": "string",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
+ "enum": [
+ "secret",
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "type": "string",
+ "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ]
+ },
+ "permission": {
+ "type": "string",
+ "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.",
+ "enum": [
+ "pull",
+ "push",
+ "admin"
+ ],
+ "default": "pull"
+ },
+ "parent_team_id": {
+ "type": "integer",
+ "description": "The ID of a team to set as the parent team.",
+ "nullable": true
}
},
"required": [
- "title",
- "body"
+ "name"
]
},
"examples": {
"default": {
"value": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled"
}
}
}
@@ -596921,1096 +593414,1250 @@
}
},
"responses": {
- "201": {
- "description": "Response",
+ "200": {
+ "description": "Response when the updated information already exists",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"example": 1
},
"node_id": {
"type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
+ "members_count": {
+ "type": "integer",
+ "example": 3
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
+ "login": {
+ "type": "string",
+ "example": "github"
+ },
+ "id": {
+ "type": "integer",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
+ },
"url": {
"type": "string",
- "format": "uri"
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "total_count": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "+1": {
- "type": "integer"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "-1": {
- "type": "integer"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "laugh": {
- "type": "integer"
+ "issues_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/issues"
},
- "confused": {
- "type": "integer"
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "heart": {
- "type": "integer"
+ "public_members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
- "hooray": {
- "type": "integer"
+ "avatar_url": {
+ "type": "string",
+ "example": "https://github.com/images/error/octocat_happy.gif"
},
- "eyes": {
- "type": "integer"
+ "description": {
+ "type": "string",
+ "example": "A great organization",
+ "nullable": true
},
- "rocket": {
- "type": "integer"
+ "name": {
+ "type": "string",
+ "example": "github"
+ },
+ "company": {
+ "type": "string",
+ "example": "GitHub"
+ },
+ "blog": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/blog"
+ },
+ "location": {
+ "type": "string",
+ "example": "San Francisco"
+ },
+ "email": {
+ "type": "string",
+ "format": "email",
+ "example": "octocat@github.com"
+ },
+ "twitter_username": {
+ "type": "string",
+ "example": "github",
+ "nullable": true
+ },
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
+ },
+ "type": {
+ "type": "string",
+ "example": "Organization"
+ },
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
+ "type": "string",
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
+ },
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
+ "type": "string",
+ "nullable": true
+ },
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
+ "type": "string",
+ "example": "all"
+ },
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "archived_at": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
+ "login",
"url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "id",
+ "node_id",
+ "repos_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
+ "type",
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
+ },
+ "ldap_dn": {
+ "type": "string",
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ },
+ "type": {
+ "description": "The ownership type of the team",
+ "type": "string",
+ "enum": [
+ "enterprise",
+ "organization"
]
+ },
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
+ },
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "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",
- "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": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
},
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
+ "201": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Full Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VGVhbTE="
+ },
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/orgs/rails/teams/core"
+ },
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
+ },
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
+ },
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
+ "type": "string"
+ },
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"example": 1
},
"node_id": {
"type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
+ "members_count": {
+ "type": "integer",
+ "example": 3
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
- "url": {
+ "login": {
"type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
+ "example": "github"
},
- "confused": {
- "type": "integer"
+ "id": {
+ "type": "integer",
+ "example": 1
},
- "heart": {
- "type": "integer"
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
},
- "hooray": {
- "type": "integer"
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "eyes": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "login": {
+ "issues_url": {
"type": "string",
- "example": "octocat"
+ "example": "https://api.github.com/orgs/github/issues"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "node_id": {
+ "public_members_url": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
"avatar_url": {
"type": "string",
- "format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
- "gravatar_id": {
+ "description": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
+ "example": "A great organization",
"nullable": true
},
- "url": {
+ "name": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "github"
},
- "html_url": {
+ "company": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "GitHub"
},
- "followers_url": {
+ "blog": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "https://github.com/blog"
},
- "following_url": {
+ "location": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "San Francisco"
},
- "gists_url": {
+ "email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "format": "email",
+ "example": "octocat@github.com"
},
- "starred_url": {
+ "twitter_username": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "github",
+ "nullable": true
},
- "subscriptions_url": {
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "https://github.com/octocat"
},
- "organizations_url": {
+ "created_at": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
},
- "repos_url": {
+ "type": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "Organization"
},
- "events_url": {
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
},
- "received_events_url": {
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "nullable": true
},
- "type": {
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
"type": "string",
- "example": "User"
+ "example": "all"
},
- "site_admin": {
- "type": "boolean"
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
},
- "starred_at": {
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "format": "date-time"
},
- "user_view_type": {
+ "archived_at": {
"type": "string",
- "example": "public"
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
+ "login",
+ "url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
"repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
"type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
},
- "team_url": {
+ "ldap_dn": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
},
- "updated_at": {
+ "type": {
+ "description": "The ownership type of the team",
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "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",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -598019,20 +594666,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": [
{
@@ -598043,20 +594690,106 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -598065,7 +594798,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
}
diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml
index 88a61276e..1bcaefc93 100644
--- a/descriptions/ghec/dereferenced/ghec.deref.yaml
+++ b/descriptions/ghec/dereferenced/ghec.deref.yaml
@@ -1029,7 +1029,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory
parameters:
- - &755
+ - &752
name: ghsa_id
description: The GHSA (GitHub Security Advisory) identifier of the advisory.
in: path
@@ -1713,7 +1713,7 @@ paths:
application/json:
schema: *3
application/scim+json:
- schema: &765
+ schema: &762
title: Scim Error
description: Scim Error
type: object
@@ -8897,7 +8897,7 @@ paths:
value:
days: 90
maximum_allowed_days: 365
- '401': &766
+ '401': &763
description: Authorization failure
'404': *6
x-github:
@@ -13108,7 +13108,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &533
+ instances_url: &530
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -13143,7 +13143,7 @@ paths:
format: date-time
readOnly: true
nullable: true
- dismissed_reason: &534
+ dismissed_reason: &531
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -13152,13 +13152,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &535
+ dismissed_comment: &532
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &536
+ rule: &533
type: object
properties:
id:
@@ -13211,7 +13211,7 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: &537
+ tool: &534
type: object
properties:
name: *111
@@ -13221,26 +13221,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *112
- most_recent_instance: &538
+ most_recent_instance: &535
type: object
properties:
- ref: &531
+ ref: &528
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &548
+ analysis_key: &545
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: &549
+ environment: &546
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: &550
+ category: &547
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -13254,7 +13254,7 @@ paths:
properties:
text:
type: string
- location: &551
+ location: &548
type: object
description: Describe a region within a file for the alert.
properties:
@@ -13275,7 +13275,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &552
+ items: &549
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -16939,7 +16939,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
- - &593
+ - &590
name: has
in: query
description: |-
@@ -17052,7 +17052,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: &594
+ security_advisory: &591
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -17284,14 +17284,14 @@ paths:
nullable: true
maxLength: 280
fixed_at: *138
- auto_dismissed_at: &595
+ auto_dismissed_at: &592
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &596
+ dismissal_request: &593
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -20776,7 +20776,7 @@ paths:
- *165
rules:
type: array
- items: &721
+ items: &718
title: Repository Rule
type: object
description: A repository rule.
@@ -20785,7 +20785,7 @@ paths:
- *171
- *172
- *173
- - &719
+ - &716
title: merge_queue
description: Merges must be performed via a merge queue.
type: object
@@ -21348,14 +21348,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &733
+ state: &730
description: Sets the state of the secret scanning alert. You
must provide `resolution` when you set the state to `resolved`.
type: string
enum:
- open
- resolved
- resolution: &734
+ resolution: &731
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -21462,8 +21462,8 @@ paths:
pull request.
'
- oneOf: &735
- - &737
+ oneOf: &732
+ - &734
description: Represents a 'commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository.
@@ -21515,7 +21515,7 @@ paths:
- blob_url
- commit_sha
- commit_url
- - &738
+ - &735
description: Represents a 'wiki_commit' secret scanning location
type. This location type shows that a secret was detected
inside a commit to a repository wiki.
@@ -21570,7 +21570,7 @@ paths:
- page_url
- commit_sha
- commit_url
- - &739
+ - &736
description: Represents an 'issue_title' secret scanning location
type. This location type shows that a secret was detected
in the title of an issue.
@@ -21584,7 +21584,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_title_url
- - &740
+ - &737
description: Represents an 'issue_body' secret scanning location
type. This location type shows that a secret was detected
in the body of an issue.
@@ -21598,7 +21598,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
required:
- issue_body_url
- - &741
+ - &738
description: Represents an 'issue_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on an issue.
@@ -21612,7 +21612,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- issue_comment_url
- - &742
+ - &739
description: Represents a 'discussion_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a discussion.
@@ -21626,7 +21626,7 @@ paths:
example: https://github.com/community/community/discussions/39082
required:
- discussion_title_url
- - &743
+ - &740
description: Represents a 'discussion_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a discussion.
@@ -21640,7 +21640,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussion-4566270
required:
- discussion_body_url
- - &744
+ - &741
description: Represents a 'discussion_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a discussion.
@@ -21654,7 +21654,7 @@ paths:
example: https://github.com/community/community/discussions/39082#discussioncomment-4158232
required:
- discussion_comment_url
- - &745
+ - &742
description: Represents a 'pull_request_title' secret scanning
location type. This location type shows that a secret was
detected in the title of a pull request.
@@ -21668,7 +21668,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_title_url
- - &746
+ - &743
description: Represents a 'pull_request_body' secret scanning
location type. This location type shows that a secret was
detected in the body of a pull request.
@@ -21682,7 +21682,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846
required:
- pull_request_body_url
- - &747
+ - &744
description: Represents a 'pull_request_comment' secret scanning
location type. This location type shows that a secret was
detected in a comment on a pull request.
@@ -21696,7 +21696,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
required:
- pull_request_comment_url
- - &748
+ - &745
description: Represents a 'pull_request_review' secret scanning
location type. This location type shows that a secret was
detected in a review on a pull request.
@@ -21710,7 +21710,7 @@ paths:
example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
required:
- pull_request_review_url
- - &749
+ - &746
description: Represents a 'pull_request_review_comment' secret
scanning location type. This location type shows that a
secret was detected in a review comment on a pull request.
@@ -25004,7 +25004,7 @@ paths:
properties:
action:
type: string
- discussion: &873
+ discussion: &868
title: Discussion
description: A Discussion in a repository.
type: object
@@ -25371,7 +25371,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &657
+ properties: &654
id:
type: integer
format: int64
@@ -25748,7 +25748,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &793
+ sub_issues_summary: &790
title: Sub-issues Summary
type: object
properties:
@@ -25768,7 +25768,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &794
+ issue_dependencies_summary: &791
title: Issue Dependencies Summary
type: object
properties:
@@ -25787,7 +25787,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &795
+ items: &792
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -25848,7 +25848,7 @@ paths:
- node_id
- data_type
- value
- required: &658
+ required: &655
- assignee
- closed_at
- comments
@@ -25886,7 +25886,7 @@ paths:
action:
type: string
issue: *221
- comment: &653
+ comment: &650
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -26605,7 +26605,7 @@ paths:
type: string
release:
allOf:
- - &712
+ - &709
title: Release
description: A release.
type: object
@@ -26676,7 +26676,7 @@ paths:
author: *4
assets:
type: array
- items: &713
+ items: &710
title: Release Asset
description: Data related to a release.
type: object
@@ -27255,7 +27255,7 @@ paths:
url:
type: string
format: uri
- user: &803
+ user: &798
title: Public User
description: Public User
type: object
@@ -30560,14 +30560,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:
- - &459
+ - &456
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &460
+ - &457
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -30629,7 +30629,7 @@ paths:
'404': *6
'403': *29
'304': *37
- '301': &465
+ '301': &462
description: Moved permanently
content:
application/json:
@@ -30651,7 +30651,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &686
+ - &683
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -30659,7 +30659,7 @@ paths:
schema:
type: boolean
default: false
- - &687
+ - &684
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -30669,7 +30669,7 @@ paths:
type: boolean
default: false
- *228
- - &688
+ - &685
name: before
description: 'Only show notifications updated before the given time. This
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
@@ -31151,7 +31151,7 @@ paths:
- url
- subscription_url
examples:
- default: &689
+ default: &686
value:
- id: '1'
repository:
@@ -32268,7 +32268,7 @@ paths:
type: array
items: *156
examples:
- default: &695
+ default: &692
value:
- property_name: environment
value: production
@@ -32318,7 +32318,7 @@ paths:
required:
- properties
examples:
- default: &696
+ default: &693
value:
properties:
- property_name: environment
@@ -33131,7 +33131,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &472
+ items: &469
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -35245,7 +35245,7 @@ paths:
type: array
items: *284
examples:
- default: &806
+ default: &801
value:
total_count: 1
repositories:
@@ -36287,7 +36287,7 @@ paths:
description: Response
content:
application/json:
- schema: &492
+ schema: &489
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -36316,7 +36316,7 @@ paths:
- key_id
- key
examples:
- default: &493
+ default: &490
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -36729,7 +36729,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables
parameters:
- *87
- - &477
+ - &474
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)."
@@ -37944,12 +37944,12 @@ paths:
required:
- subject_digests
examples:
- default: &834
+ default: &829
value:
subject_digests:
- sha256:abc123
- sha512:def456
- withPredicateType: &835
+ withPredicateType: &830
value:
subject_digests:
- sha256:abc123
@@ -38007,7 +38007,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: &836
+ default: &831
value:
attestations_subject_digests:
- sha256:abc:
@@ -38356,7 +38356,7 @@ paths:
initiator:
type: string
examples:
- default: &506
+ default: &503
value:
attestations:
- bundle:
@@ -39273,7 +39273,7 @@ paths:
be returned.
in: query
required: false
- schema: &532
+ schema: &529
type: string
description: Severity of a code scanning alert.
enum:
@@ -40328,7 +40328,7 @@ paths:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: &564
+ properties: &561
name:
type: string
description: The name of the machine.
@@ -40370,7 +40370,7 @@ paths:
- ready
- in_progress
nullable: true
- required: &565
+ required: &562
- name
- display_name
- operating_system
@@ -41238,7 +41238,7 @@ paths:
- updated_at
- visibility
examples:
- default: &566
+ default: &563
value:
total_count: 2
secrets:
@@ -41276,7 +41276,7 @@ paths:
description: Response
content:
application/json:
- schema: &567
+ schema: &564
title: CodespacesPublicKey
description: The public key used for setting Codespaces secrets.
type: object
@@ -41305,7 +41305,7 @@ paths:
- key_id
- key
examples:
- default: &568
+ default: &565
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -41337,7 +41337,7 @@ paths:
application/json:
schema: *327
examples:
- default: &570
+ default: &567
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -43196,7 +43196,7 @@ paths:
description: Response
content:
application/json:
- schema: &599
+ schema: &596
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -43213,7 +43213,7 @@ paths:
- key_id
- key
examples:
- default: &600
+ default: &597
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -43543,7 +43543,7 @@ paths:
subcategory: alert-dismissal-requests
parameters:
- *87
- - &608
+ - &605
name: reviewer
description: Filter alert dismissal requests by the handle of the GitHub user
who reviewed the dismissal request.
@@ -43551,7 +43551,7 @@ paths:
required: false
schema:
type: string
- - &609
+ - &606
name: requester
description: Filter alert dismissal requests by the handle of the GitHub user
who requested the dismissal.
@@ -43559,7 +43559,7 @@ paths:
required: false
schema:
type: string
- - &610
+ - &607
name: time_period
description: |-
The time period to filter by.
@@ -43575,7 +43575,7 @@ paths:
- week
- month
default: month
- - &611
+ - &608
name: request_status
description: Filter alert dismissal requests by status. When specified, only
requests with this status will be returned.
@@ -43600,7 +43600,7 @@ paths:
application/json:
schema:
type: array
- items: &612
+ items: &609
title: Code scanning alert dismissal request
description: Alert dismisal request made by a user asking to dismiss
a code scanning alert.
@@ -43756,7 +43756,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/code-scanning/alerts/1
examples:
- default: &613
+ default: &610
value:
- id: 21
number: 42
@@ -43874,7 +43874,7 @@ paths:
application/json:
schema:
type: array
- items: &614
+ items: &611
title: Dependabot alert dismissal request
description: Alert dismissal request made by a user asking to dismiss
a Dependabot alert.
@@ -43991,7 +43991,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/security/dependabot/1
examples:
- default: &615
+ default: &612
value:
- id: 21
number: 42
@@ -44093,7 +44093,7 @@ paths:
application/json:
schema:
type: array
- items: &616
+ items: &613
title: Secret scanning alert dismissal request
description: A dismissal request made by a user asking to close
a secret scanning alert in this repository.
@@ -44214,7 +44214,7 @@ paths:
format: uri
example: https://github.com/octo-org/smile/security/secret-scanning/17
examples:
- default: &617
+ default: &614
value:
- id: 21
number: 42
@@ -44559,7 +44559,7 @@ paths:
description: Response
content:
application/json:
- schema: &456
+ schema: &453
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -44640,7 +44640,7 @@ paths:
example: mona_lisa@github.com
type: string
examples:
- default: &457
+ default: &454
value:
group_id: '123'
group_name: Octocat admins
@@ -44695,7 +44695,7 @@ paths:
description: Response
content:
application/json:
- schema: &454
+ schema: &451
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -44732,7 +44732,7 @@ paths:
example: 2019-06-03 22:27:15:000 -700
type: string
examples:
- default: &455
+ default: &452
value:
groups:
- group_id: '123'
@@ -46034,7 +46034,7 @@ paths:
application/json:
schema: *22
examples:
- default: &648
+ default: &645
value:
id: 1
account:
@@ -46259,7 +46259,7 @@ paths:
required: true
content:
application/json:
- schema: &649
+ schema: &646
title: Interaction Restrictions
description: Limit interactions to a specific type of user for a specified
duration
@@ -47120,7 +47120,7 @@ paths:
application/json:
schema: *376
examples:
- default: &563
+ default: &560
value:
id: 1
name: monalisa-octocat-hello-world-g4wpq6h95q
@@ -48369,7 +48369,7 @@ paths:
parameters:
- *87
- *382
- - &819
+ - &814
name: repo_name
description: repo_name parameter
in: path
@@ -49695,7 +49695,7 @@ paths:
- nuget
- container
- *87
- - &820
+ - &815
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -49736,7 +49736,7 @@ paths:
default: *388
'403': *29
'401': *25
- '400': &822
+ '400': &817
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -51528,7 +51528,7 @@ paths:
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: &909
+ properties: &904
id:
type: number
description: The unique identifier of the status update.
@@ -51576,7 +51576,7 @@ paths:
example: The project is off to a great start!
type: string
nullable: true
- required: &910
+ required: &905
- id
- node_id
- created_at
@@ -51790,7 +51790,7 @@ paths:
content:
oneOf:
- *221
- - &580
+ - &577
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -52019,7 +52019,7 @@ paths:
- review_comment
- self
author_association: *222
- auto_merge: &698
+ auto_merge: &695
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -52394,7 +52394,7 @@ paths:
- updated_at
- project_url
examples:
- default: &839
+ default: &834
value:
- id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -52571,7 +52571,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: &840
+ items: &835
type: object
properties:
name:
@@ -52607,7 +52607,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: &841
+ iteration_configuration: &836
type: object
description: The configuration for iteration fields.
properties:
@@ -52656,7 +52656,7 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: &842
+ single_select_field: &837
summary: Create a single select field
value:
name: Priority
@@ -52683,7 +52683,7 @@ paths:
description:
raw: High priority items
html: High priority items
- iteration_field: &843
+ iteration_field: &838
summary: Create an iteration field
value:
name: Sprint
@@ -52709,7 +52709,7 @@ paths:
application/json:
schema: *409
examples:
- text_field: &844
+ text_field: &839
value:
id: 24680
node_id: PVTF_lADOABCD2468024680
@@ -52718,7 +52718,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-05-15T08:00:00Z'
updated_at: '2022-05-15T08:00:00Z'
- number_field: &845
+ number_field: &840
value:
id: 13579
node_id: PVTF_lADOABCD1357913579
@@ -52727,7 +52727,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-01T14:30:00Z'
updated_at: '2022-06-01T14:30:00Z'
- date_field: &846
+ date_field: &841
value:
id: 98765
node_id: PVTF_lADOABCD9876598765
@@ -52736,7 +52736,7 @@ paths:
project_url: https://api.github.com/projects/67890
created_at: '2022-06-10T09:15:00Z'
updated_at: '2022-06-10T09:15:00Z'
- single_select_field: &847
+ single_select_field: &842
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -52770,7 +52770,7 @@ paths:
raw: High priority items
created_at: '2022-04-28T12:00:00Z'
updated_at: '2022-04-28T12:00:00Z'
- iteration_field: &848
+ iteration_field: &843
value:
id: 11223
node_id: PVTF_lADOABCD1122311223
@@ -52816,7 +52816,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization
parameters:
- *405
- - &849
+ - &844
name: field_id
description: The unique identifier of the field.
in: path
@@ -52831,7 +52831,7 @@ paths:
application/json:
schema: *409
examples:
- default: &850
+ default: &845
value:
id: 12345
node_id: PVTF_lADOABCD1234567890
@@ -53957,7 +53957,7 @@ paths:
parameters:
- *405
- *87
- - &851
+ - &846
name: view_number
description: The number that identifies the project view.
in: path
@@ -54723,7 +54723,7 @@ paths:
description: Response
content:
application/json:
- schema: &464
+ schema: &461
title: Full Repository
description: Full Repository
type: object
@@ -55116,7 +55116,7 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: &585
+ properties: &582
url:
type: string
format: uri
@@ -55132,7 +55132,7 @@ paths:
nullable: true
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
- required: &586
+ required: &583
- url
- key
- name
@@ -55221,7 +55221,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &466
+ default: &463
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -55774,7 +55774,7 @@ paths:
- *87
- *17
- *19
- - &720
+ - &717
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -55989,7 +55989,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *87
- - &722
+ - &719
name: ref
description: The name of the ref. Cannot contain wildcard characters. Optionally
prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit
@@ -56001,14 +56001,14 @@ paths:
x-multi-segment: true
- *310
- *105
- - &723
+ - &720
name: actor_name
description: The handle for the GitHub user account to filter on. When specified,
only rule evaluations triggered by this actor will be returned.
in: query
schema:
type: string
- - &724
+ - &721
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -56028,7 +56028,7 @@ paths:
description: Response
content:
application/json:
- schema: &725
+ schema: &722
title: Rule Suites
description: Response
type: array
@@ -56083,7 +56083,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &726
+ default: &723
value:
- id: 21
actor_id: 12
@@ -56127,7 +56127,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *87
- - &727
+ - &724
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -56143,7 +56143,7 @@ paths:
description: Response
content:
application/json:
- schema: &728
+ schema: &725
title: Rule Suite
description: Response
type: object
@@ -56242,7 +56242,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &729
+ default: &726
value:
id: 21
actor_id: 12
@@ -56574,7 +56574,7 @@ paths:
- *110
- *19
- *17
- - &731
+ - &728
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -56584,7 +56584,7 @@ paths:
required: false
schema:
type: string
- - &732
+ - &729
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -56797,7 +56797,7 @@ paths:
application/json:
schema:
type: array
- items: &753
+ items: &750
description: A repository security advisory.
type: object
properties:
@@ -57088,7 +57088,7 @@ paths:
- private_fork
additionalProperties: false
examples:
- default: &754
+ default: &751
value:
- ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -58097,7 +58097,7 @@ paths:
description: Response
content:
application/json:
- schema: &461
+ schema: &458
title: GroupMapping
description: External Groups to be mapped to a team for membership
type: object
@@ -58143,7 +58143,7 @@ paths:
type: string
nullable: true
examples:
- default: &462
+ default: &459
value:
groups:
- group_id: '123'
@@ -58885,454 +58885,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions
- parameters:
- - *87
- - *216
- - *110
- - *17
- - *19
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &451
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form
- conversation within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *20
- required: *21
- nullable: true
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a
- team
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned
- for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted
- to team members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions: *223
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
- examples:
- default: &797
- value:
- - author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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: *47
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion
- parameters:
- - *87
- - *216
- 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: *451
- examples:
- default: &452
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Our first team post
- updated_at: '2018-01-25T18:56:31Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion
- parameters:
- - *87
- - *216
- - &453
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *451
- examples:
- default: *452
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion
- parameters:
- - *87
- - *216
- - *453
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *451
- examples:
- default: &798
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Welcome to our first team post
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion
- parameters:
- - *87
- - *216
- - *453
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -59354,9 +58906,9 @@ paths:
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: *455
+ default: *452
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -59399,9 +58951,9 @@ paths:
description: Response
content:
application/json:
- schema: *456
+ schema: *453
examples:
- default: *457
+ default: *454
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -59542,7 +59094,7 @@ paths:
description: Response
content:
application/json:
- schema: &458
+ schema: &455
title: Team Membership
description: Team Membership
type: object
@@ -59569,7 +59121,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &799
+ response-if-user-is-a-team-maintainer: &794
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -59632,9 +59184,9 @@ paths:
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- response-if-users-membership-with-team-is-now-pending: &800
+ response-if-users-membership-with-team-is-now-pending: &795
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -59741,14 +59293,14 @@ paths:
parameters:
- *87
- *216
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &801
+ schema: &796
title: Team Repository
description: A team's access to a repository.
type: object
@@ -60319,8 +59871,8 @@ paths:
parameters:
- *87
- *216
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -60367,8 +59919,8 @@ paths:
parameters:
- *87
- *216
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -60401,9 +59953,9 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: *462
+ default: *459
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -60469,7 +60021,7 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
default:
value:
@@ -60514,7 +60066,7 @@ paths:
type: array
items: *313
examples:
- response-if-child-teams-exist: &802
+ response-if-child-teams-exist: &797
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -60668,7 +60220,7 @@ paths:
resources:
type: object
properties:
- core: &463
+ core: &460
title: Rate Limit
type: object
properties:
@@ -60685,21 +60237,21 @@ paths:
- remaining
- reset
- used
- graphql: *463
- search: *463
- code_search: *463
- source_import: *463
- integration_manifest: *463
- code_scanning_upload: *463
- actions_runner_registration: *463
- scim: *463
- dependency_snapshots: *463
- dependency_sbom: *463
- code_scanning_autofix: *463
+ graphql: *460
+ search: *460
+ code_search: *460
+ source_import: *460
+ integration_manifest: *460
+ code_scanning_upload: *460
+ actions_runner_registration: *460
+ scim: *460
+ dependency_snapshots: *460
+ dependency_sbom: *460
+ code_scanning_autofix: *460
required:
- core
- search
- rate: *463
+ rate: *460
required:
- rate
- resources
@@ -60804,14 +60356,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
default-response:
summary: Default response
@@ -61316,7 +60868,7 @@ paths:
status: disabled
'403': *29
'404': *6
- '301': *465
+ '301': *462
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61334,8 +60886,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -61592,10 +61144,10 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
- '307': &467
+ default: *463
+ '307': &464
description: Temporary Redirect
content:
application/json:
@@ -61624,8 +61176,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -61647,7 +61199,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': *467
+ '307': *464
'404': *6
'409': *119
x-github:
@@ -61671,11 +61223,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
- - &484
+ - &481
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -61698,7 +61250,7 @@ paths:
type: integer
artifacts:
type: array
- items: &468
+ items: &465
title: Artifact
description: An artifact
type: object
@@ -61776,7 +61328,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &485
+ default: &482
value:
total_count: 2
artifacts:
@@ -61837,9 +61389,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact
parameters:
- - *459
- - *460
- - &469
+ - *456
+ - *457
+ - &466
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -61851,7 +61403,7 @@ paths:
description: Response
content:
application/json:
- schema: *468
+ schema: *465
examples:
default:
value:
@@ -61889,9 +61441,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact
parameters:
- - *459
- - *460
- - *469
+ - *456
+ - *457
+ - *466
responses:
'204':
description: Response
@@ -61915,9 +61467,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact
parameters:
- - *459
- - *460
- - *469
+ - *456
+ - *457
+ - *466
- name: archive_format
in: path
required: true
@@ -61931,7 +61483,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': &652
+ '410': &649
description: Gone
content:
application/json:
@@ -61956,14 +61508,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &470
+ schema: &467
title: Actions cache retention limit for a repository
description: GitHub Actions cache retention policy for a repository.
type: object
@@ -61996,13 +61548,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
application/json:
- schema: *470
+ schema: *467
examples:
selected_actions: *44
responses:
@@ -62031,14 +61583,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &471
+ schema: &468
title: Actions cache storage limit for a repository
description: GitHub Actions cache storage policy for a repository.
type: object
@@ -62071,13 +61623,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
application/json:
- schema: *471
+ schema: *468
examples:
selected_actions: *46
responses:
@@ -62108,14 +61660,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *472
+ schema: *469
examples:
default:
value:
@@ -62141,11 +61693,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:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
- - &473
+ - &470
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
@@ -62179,7 +61731,7 @@ paths:
description: Response
content:
application/json:
- schema: &474
+ schema: &471
title: Repository actions caches
description: Repository actions caches
type: object
@@ -62221,7 +61773,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &475
+ default: &472
value:
total_count: 1
actions_caches:
@@ -62253,23 +61805,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:
- - *459
- - *460
+ - *456
+ - *457
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *473
+ - *470
responses:
'200':
description: Response
content:
application/json:
- schema: *474
+ schema: *471
examples:
- default: *475
+ default: *472
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62289,8 +61841,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:
- - *459
- - *460
+ - *456
+ - *457
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -62321,9 +61873,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:
- - *459
- - *460
- - &476
+ - *456
+ - *457
+ - &473
name: job_id
description: The unique identifier of the job.
in: path
@@ -62335,7 +61887,7 @@ paths:
description: Response
content:
application/json:
- schema: &488
+ schema: &485
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -62642,9 +62194,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:
- - *459
- - *460
- - *476
+ - *456
+ - *457
+ - *473
responses:
'302':
description: Response
@@ -62672,9 +62224,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:
- - *459
- - *460
- - *476
+ - *456
+ - *457
+ - *473
requestBody:
required: false
content:
@@ -62719,8 +62271,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Status response
@@ -62770,8 +62322,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -62834,8 +62386,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -62853,7 +62405,7 @@ paths:
type: integer
secrets:
type: array
- items: &490
+ items: &487
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -62873,7 +62425,7 @@ paths:
- created_at
- updated_at
examples:
- default: &491
+ default: &488
value:
total_count: 2
secrets:
@@ -62906,9 +62458,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables
parameters:
- - *459
- - *460
- - *477
+ - *456
+ - *457
+ - *474
- *19
responses:
'200':
@@ -62925,7 +62477,7 @@ paths:
type: integer
variables:
type: array
- items: &494
+ items: &491
title: Actions Variable
type: object
properties:
@@ -62955,7 +62507,7 @@ paths:
- created_at
- updated_at
examples:
- default: &495
+ default: &492
value:
total_count: 2
variables:
@@ -62988,8 +62540,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -62998,7 +62550,7 @@ paths:
schema:
type: object
properties:
- enabled: &478
+ enabled: &475
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *60
@@ -63033,8 +62585,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -63045,7 +62597,7 @@ paths:
schema:
type: object
properties:
- enabled: *478
+ enabled: *475
allowed_actions: *60
sha_pinning_required: *61
required:
@@ -63078,14 +62630,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &479
+ schema: &476
type: object
properties:
access_level:
@@ -63103,7 +62655,7 @@ paths:
required:
- access_level
examples:
- default: &480
+ default: &477
value:
access_level: organization
x-github:
@@ -63128,15 +62680,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
application/json:
- schema: *479
+ schema: *476
examples:
- default: *480
+ default: *477
responses:
'204':
description: Response
@@ -63160,8 +62712,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63191,8 +62743,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Empty response for successful settings update
@@ -63226,8 +62778,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63254,8 +62806,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -63289,8 +62841,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63318,8 +62870,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -63350,8 +62902,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63382,8 +62934,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -63415,8 +62967,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63445,8 +62997,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Success response
@@ -63486,8 +63038,8 @@ paths:
in: query
schema:
type: string
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -63531,8 +63083,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -63564,8 +63116,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -63639,8 +63191,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'201':
description: Response
@@ -63676,8 +63228,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'201':
description: Response
@@ -63707,8 +63259,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
responses:
'200':
@@ -63738,8 +63290,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
responses:
'204':
@@ -63766,8 +63318,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
responses:
'200': *81
@@ -63792,8 +63344,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
requestBody:
required: true
@@ -63842,8 +63394,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
requestBody:
required: true
@@ -63893,8 +63445,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
responses:
'200': *291
@@ -63924,8 +63476,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:
- - *459
- - *460
+ - *456
+ - *457
- *75
- *292
responses:
@@ -63955,9 +63507,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:
- - *459
- - *460
- - &498
+ - *456
+ - *457
+ - &495
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.
@@ -63965,7 +63517,7 @@ paths:
required: false
schema:
type: string
- - &499
+ - &496
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -63973,7 +63525,7 @@ paths:
required: false
schema:
type: string
- - &500
+ - &497
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -63982,7 +63534,7 @@ paths:
required: false
schema:
type: string
- - &501
+ - &498
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
@@ -64009,7 +63561,7 @@ paths:
- pending
- *17
- *19
- - &502
+ - &499
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)."
@@ -64018,7 +63570,7 @@ paths:
schema:
type: string
format: date-time
- - &481
+ - &478
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -64027,13 +63579,13 @@ paths:
schema:
type: boolean
default: false
- - &503
+ - &500
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &504
+ - &501
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -64056,7 +63608,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &482
+ items: &479
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -64204,7 +63756,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &526
+ properties: &523
id:
type: string
description: SHA for the commit
@@ -64255,7 +63807,7 @@ paths:
- name
- email
nullable: true
- required: &527
+ required: &524
- id
- tree_id
- message
@@ -64302,7 +63854,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &505
+ default: &502
value:
total_count: 1
workflow_runs:
@@ -64538,24 +64090,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *459
- - *460
- - &483
+ - *456
+ - *457
+ - &480
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *481
+ - *478
responses:
'200':
description: Response
content:
application/json:
- schema: *482
+ schema: *479
examples:
- default: &486
+ default: &483
value:
id: 30433642
name: Build
@@ -64796,9 +64348,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'204':
description: Response
@@ -64821,9 +64373,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'200':
description: Response
@@ -64942,9 +64494,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'201':
description: Response
@@ -64977,12 +64529,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
- *17
- *19
- - *484
+ - *481
responses:
'200':
description: Response
@@ -64998,9 +64550,9 @@ paths:
type: integer
artifacts:
type: array
- items: *468
+ items: *465
examples:
- default: *485
+ default: *482
headers:
Link: *47
x-github:
@@ -65024,25 +64576,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *459
- - *460
- - *483
- - &487
+ - *456
+ - *457
+ - *480
+ - &484
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *481
+ - *478
responses:
'200':
description: Response
content:
application/json:
- schema: *482
+ schema: *479
examples:
- default: *486
+ default: *483
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -65065,10 +64617,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:
- - *459
- - *460
- - *483
- - *487
+ - *456
+ - *457
+ - *480
+ - *484
- *17
- *19
responses:
@@ -65086,9 +64638,9 @@ paths:
type: integer
jobs:
type: array
- items: *488
+ items: *485
examples:
- default: &489
+ default: &486
value:
total_count: 1
jobs:
@@ -65201,10 +64753,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *459
- - *460
- - *483
- - *487
+ - *456
+ - *457
+ - *480
+ - *484
responses:
'302':
description: Response
@@ -65232,9 +64784,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'202':
description: Response
@@ -65267,9 +64819,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
requestBody:
required: true
content:
@@ -65336,9 +64888,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'202':
description: Response
@@ -65371,9 +64923,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
- 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
@@ -65403,9 +64955,9 @@ paths:
type: integer
jobs:
type: array
- items: *488
+ items: *485
examples:
- default: *489
+ default: *486
headers:
Link: *47
x-github:
@@ -65430,9 +64982,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'302':
description: Response
@@ -65459,9 +65011,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'204':
description: Response
@@ -65488,9 +65040,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'200':
description: Response
@@ -65550,7 +65102,7 @@ paths:
items:
type: object
properties:
- type: &618
+ type: &615
type: string
description: The type of reviewer.
enum:
@@ -65635,9 +65187,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
requestBody:
required: true
content:
@@ -65684,7 +65236,7 @@ paths:
application/json:
schema:
type: array
- items: &603
+ items: &600
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -65790,7 +65342,7 @@ paths:
- created_at
- updated_at
examples:
- default: &604
+ default: &601
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -65846,9 +65398,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
requestBody:
required: false
content:
@@ -65892,9 +65444,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:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
requestBody:
required: false
content:
@@ -65948,9 +65500,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage
parameters:
- - *459
- - *460
- - *483
+ - *456
+ - *457
+ - *480
responses:
'200':
description: Response
@@ -66087,8 +65639,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -66106,9 +65658,9 @@ paths:
type: integer
secrets:
type: array
- items: *490
+ items: *487
examples:
- default: *491
+ default: *488
headers:
Link: *47
x-github:
@@ -66133,16 +65685,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *492
+ schema: *489
examples:
- default: *493
+ default: *490
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66164,17 +65716,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'200':
description: Response
content:
application/json:
- schema: *490
+ schema: *487
examples:
- default: &631
+ default: &628
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -66200,8 +65752,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
requestBody:
required: true
@@ -66259,8 +65811,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'204':
@@ -66286,9 +65838,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables
parameters:
- - *459
- - *460
- - *477
+ - *456
+ - *457
+ - *474
- *19
responses:
'200':
@@ -66305,9 +65857,9 @@ paths:
type: integer
variables:
type: array
- items: *494
+ items: *491
examples:
- default: *495
+ default: *492
headers:
Link: *47
x-github:
@@ -66330,8 +65882,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -66383,17 +65935,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
responses:
'200':
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: &632
+ default: &629
value:
name: USERNAME
value: octocat
@@ -66419,8 +65971,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
requestBody:
required: true
@@ -66463,8 +66015,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
responses:
'204':
@@ -66490,8 +66042,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -66509,7 +66061,7 @@ paths:
type: integer
workflows:
type: array
- items: &496
+ items: &493
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -66616,9 +66168,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow
parameters:
- - *459
- - *460
- - &497
+ - *456
+ - *457
+ - &494
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -66633,7 +66185,7 @@ paths:
description: Response
content:
application/json:
- schema: *496
+ schema: *493
examples:
default:
value:
@@ -66666,9 +66218,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow
parameters:
- - *459
- - *460
- - *497
+ - *456
+ - *457
+ - *494
responses:
'204':
description: Response
@@ -66693,9 +66245,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *459
- - *460
- - *497
+ - *456
+ - *457
+ - *494
responses:
'204':
description: Response
@@ -66746,9 +66298,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow
parameters:
- - *459
- - *460
- - *497
+ - *456
+ - *457
+ - *494
responses:
'204':
description: Response
@@ -66775,19 +66327,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:
- - *459
- - *460
+ - *456
+ - *457
+ - *494
+ - *495
+ - *496
- *497
- *498
+ - *17
+ - *19
- *499
+ - *478
- *500
- *501
- - *17
- - *19
- - *502
- - *481
- - *503
- - *504
responses:
'200':
description: Response
@@ -66803,9 +66355,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *482
+ items: *479
examples:
- default: *505
+ default: *502
headers:
Link: *47
x-github:
@@ -66838,9 +66390,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage
parameters:
- - *459
- - *460
- - *497
+ - *456
+ - *457
+ - *494
responses:
'200':
description: Response
@@ -66901,8 +66453,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *110
- *17
- *108
@@ -67066,8 +66618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -67104,8 +66656,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:
- - *459
- - *460
+ - *456
+ - *457
- name: assignee
in: path
required: true
@@ -67141,8 +66693,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#create-an-attestation
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -67254,8 +66806,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/attestations#list-attestations
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *108
- *109
@@ -67312,7 +66864,7 @@ paths:
initiator:
type: string
examples:
- default: *506
+ default: *503
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -67332,8 +66884,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -67341,7 +66893,7 @@ paths:
application/json:
schema:
type: array
- items: &507
+ items: &504
title: Autolink reference
description: An autolink reference.
type: object
@@ -67395,8 +66947,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -67435,9 +66987,9 @@ paths:
description: response
content:
application/json:
- schema: *507
+ schema: *504
examples:
- default: &508
+ default: &505
value:
id: 1
key_prefix: TICKET-
@@ -67468,9 +67020,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:
- - *459
- - *460
- - &509
+ - *456
+ - *457
+ - &506
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -67482,9 +67034,9 @@ paths:
description: Response
content:
application/json:
- schema: *507
+ schema: *504
examples:
- default: *508
+ default: *505
'404': *6
x-github:
githubCloudOnly: false
@@ -67504,9 +67056,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:
- - *459
- - *460
- - *509
+ - *456
+ - *457
+ - *506
responses:
'204':
description: Response
@@ -67530,8 +67082,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response if Dependabot is enabled
@@ -67579,8 +67131,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -67601,8 +67153,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -67622,8 +67174,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -67661,7 +67213,7 @@ paths:
- url
protected:
type: boolean
- protection: &511
+ protection: &508
title: Branch Protection
description: Branch Protection
type: object
@@ -67703,7 +67255,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &514
+ enforce_admins: &511
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -67718,7 +67270,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &516
+ required_pull_request_reviews: &513
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -67794,7 +67346,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &513
+ restrictions: &510
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -68071,9 +67623,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch
parameters:
- - *459
- - *460
- - &512
+ - *456
+ - *457
+ - &509
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).
@@ -68087,14 +67639,14 @@ paths:
description: Response
content:
application/json:
- schema: &522
+ schema: &519
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &576
+ commit: &573
title: Commit
description: Commit
type: object
@@ -68128,7 +67680,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &510
+ properties: &507
name:
type: string
example: '"Chris Wanstrath"'
@@ -68144,7 +67696,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *510
+ properties: *507
nullable: true
message:
type: string
@@ -68165,7 +67717,7 @@ paths:
required:
- sha
- url
- verification: &638
+ verification: &635
title: Verification
type: object
properties:
@@ -68235,7 +67787,7 @@ paths:
type: integer
files:
type: array
- items: &589
+ items: &586
title: Diff Entry
description: Diff Entry
type: object
@@ -68319,7 +67871,7 @@ paths:
- self
protected:
type: boolean
- protection: *511
+ protection: *508
protection_url:
type: string
format: uri
@@ -68426,7 +67978,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *465
+ '301': *462
'404': *6
x-github:
githubCloudOnly: false
@@ -68448,15 +68000,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
default:
value:
@@ -68650,9 +68202,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -68907,7 +68459,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &519
+ required_status_checks: &516
title: Status Check Policy
description: Status Check Policy
type: object
@@ -69059,7 +68611,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *513
+ restrictions: *510
required_conversation_resolution:
type: object
properties:
@@ -69171,9 +68723,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69198,17 +68750,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &515
+ default: &512
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -69230,17 +68782,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *515
+ default: *512
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -69259,9 +68811,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69286,17 +68838,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *516
+ schema: *513
examples:
- default: &517
+ default: &514
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -69392,9 +68944,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -69492,9 +69044,9 @@ paths:
description: Response
content:
application/json:
- schema: *516
+ schema: *513
examples:
- default: *517
+ default: *514
'422': *15
x-github:
githubCloudOnly: false
@@ -69515,9 +69067,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69544,17 +69096,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: &518
+ default: &515
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -69577,17 +69129,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *514
+ schema: *511
examples:
- default: *518
+ default: *515
'404': *6
x-github:
githubCloudOnly: false
@@ -69607,9 +69159,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69634,17 +69186,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: &520
+ default: &517
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -69670,9 +69222,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -69724,9 +69276,9 @@ paths:
description: Response
content:
application/json:
- schema: *519
+ schema: *516
examples:
- default: *520
+ default: *517
'404': *6
'422': *15
x-github:
@@ -69748,9 +69300,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -69774,9 +69326,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
@@ -69810,9 +69362,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -69879,9 +69431,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -69945,9 +69497,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
content:
application/json:
@@ -70013,15 +69565,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *513
+ schema: *510
examples:
default:
value:
@@ -70112,9 +69664,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'204':
description: Response
@@ -70137,9 +69689,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:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
@@ -70149,7 +69701,7 @@ paths:
type: array
items: *5
examples:
- default: &521
+ default: &518
value:
- id: 1
slug: octoapp
@@ -70206,9 +69758,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70242,7 +69794,7 @@ paths:
type: array
items: *5
examples:
- default: *521
+ default: *518
'422': *15
x-github:
githubCloudOnly: false
@@ -70263,9 +69815,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70299,7 +69851,7 @@ paths:
type: array
items: *5
examples:
- default: *521
+ default: *518
'422': *15
x-github:
githubCloudOnly: false
@@ -70320,9 +69872,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70356,7 +69908,7 @@ paths:
type: array
items: *5
examples:
- default: *521
+ default: *518
'422': *15
x-github:
githubCloudOnly: false
@@ -70378,9 +69930,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:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
@@ -70410,9 +69962,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -70471,9 +70023,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: false
content:
@@ -70532,9 +70084,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
content:
application/json:
@@ -70593,9 +70145,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:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
responses:
'200':
description: Response
@@ -70629,9 +70181,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70689,9 +70241,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70749,9 +70301,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70811,9 +70363,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
requestBody:
required: true
content:
@@ -70835,7 +70387,7 @@ paths:
description: Response
content:
application/json:
- schema: *522
+ schema: *519
examples:
default:
value:
@@ -70949,8 +70501,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *103
- *104
- *105
@@ -70986,8 +70538,8 @@ paths:
category: repos
subcategory: bypass-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: bypass_request_number
in: path
required: true
@@ -71060,8 +70612,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *103
- *104
- *105
@@ -71101,8 +70653,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: bypass_request_number
in: path
required: true
@@ -71172,8 +70724,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: bypass_request_number
in: path
required: true
@@ -71244,8 +70796,8 @@ paths:
category: secret-scanning
subcategory: delegated-bypass
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: bypass_response_id
in: path
required: true
@@ -71278,8 +70830,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -71558,7 +71110,7 @@ paths:
description: Response
content:
application/json:
- schema: &523
+ schema: &520
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -71678,7 +71230,7 @@ paths:
check.
type: array
items: *226
- deployment: &862
+ deployment: &857
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -71958,9 +71510,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run
parameters:
- - *459
- - *460
- - &524
+ - *456
+ - *457
+ - &521
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -71972,9 +71524,9 @@ paths:
description: Response
content:
application/json:
- schema: *523
+ schema: *520
examples:
- default: &525
+ default: &522
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -72074,9 +71626,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run
parameters:
- - *459
- - *460
- - *524
+ - *456
+ - *457
+ - *521
requestBody:
required: true
content:
@@ -72316,9 +71868,9 @@ paths:
description: Response
content:
application/json:
- schema: *523
+ schema: *520
examples:
- default: *525
+ default: *522
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72338,9 +71890,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations
parameters:
- - *459
- - *460
- - *524
+ - *456
+ - *457
+ - *521
- *17
- *19
responses:
@@ -72435,9 +71987,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run
parameters:
- - *459
- - *460
- - *524
+ - *456
+ - *457
+ - *521
responses:
'201':
description: Response
@@ -72481,8 +72033,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -72504,7 +72056,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &528
+ schema: &525
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -72590,12 +72142,12 @@ paths:
type: string
format: date-time
nullable: true
- head_commit: &893
+ head_commit: &888
title: Simple Commit
description: A commit.
type: object
- properties: *526
- required: *527
+ properties: *523
+ required: *524
latest_check_runs_count:
type: integer
check_runs_url:
@@ -72623,7 +72175,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &529
+ default: &526
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -72914,9 +72466,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: *529
+ default: *526
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72935,8 +72487,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -73245,9 +72797,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite
parameters:
- - *459
- - *460
- - &530
+ - *456
+ - *457
+ - &527
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -73259,9 +72811,9 @@ paths:
description: Response
content:
application/json:
- schema: *528
+ schema: *525
examples:
- default: *529
+ default: *526
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -73284,17 +72836,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:
- - *459
- - *460
- - *530
- - &582
+ - *456
+ - *457
+ - *527
+ - &579
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &583
+ - &580
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -73333,9 +72885,9 @@ paths:
type: integer
check_runs:
type: array
- items: *523
+ items: *520
examples:
- default: &584
+ default: &581
value:
total_count: 1
check_runs:
@@ -73437,9 +72989,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite
parameters:
- - *459
- - *460
- - *530
+ - *456
+ - *457
+ - *527
responses:
'201':
description: Response
@@ -73472,21 +73024,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:
- - *459
- - *460
+ - *456
+ - *457
- *317
- *318
- *19
- *17
- - &546
+ - &543
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: *531
- - &547
+ schema: *528
+ - &544
name: pr
description: The number of the pull request for the results you want to list.
in: query
@@ -73517,7 +73069,7 @@ paths:
be returned.
in: query
required: false
- schema: *532
+ schema: *529
- name: assignees
description: |
Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
@@ -73541,7 +73093,7 @@ paths:
updated_at: *136
url: *133
html_url: *134
- instances_url: *533
+ instances_url: *530
state: *113
fixed_at: *138
dismissed_by:
@@ -73552,11 +73104,11 @@ paths:
required: *21
nullable: true
dismissed_at: *137
- dismissed_reason: *534
- dismissed_comment: *535
- rule: *536
- tool: *537
- most_recent_instance: *538
+ dismissed_reason: *531
+ dismissed_comment: *532
+ rule: *533
+ tool: *534
+ most_recent_instance: *535
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -73682,7 +73234,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *37
- '403': &539
+ '403': &536
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -73709,9 +73261,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:
- - *459
- - *460
- - &540
+ - *456
+ - *457
+ - &537
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -73725,7 +73277,7 @@ paths:
description: Response
content:
application/json:
- schema: &541
+ schema: &538
type: object
properties:
number: *128
@@ -73733,7 +73285,7 @@ paths:
updated_at: *136
url: *133
html_url: *134
- instances_url: *533
+ instances_url: *530
state: *113
fixed_at: *138
dismissed_by:
@@ -73744,8 +73296,8 @@ paths:
required: *21
nullable: true
dismissed_at: *137
- dismissed_reason: *534
- dismissed_comment: *535
+ dismissed_reason: *531
+ dismissed_comment: *532
rule:
type: object
properties:
@@ -73799,8 +73351,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *537
- most_recent_instance: *538
+ tool: *534
+ most_recent_instance: *535
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -73899,7 +73451,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *37
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -73919,9 +73471,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
requestBody:
required: true
content:
@@ -73936,8 +73488,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *534
- dismissed_comment: *535
+ dismissed_reason: *531
+ dismissed_comment: *532
create_request:
type: boolean
description: If `true`, attempt to create an alert dismissal request.
@@ -73965,7 +73517,7 @@ paths:
description: Response
content:
application/json:
- schema: *541
+ schema: *538
examples:
default:
value:
@@ -74041,7 +73593,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *14
- '403': &545
+ '403': &542
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -74068,15 +73620,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
responses:
'200':
description: Response
content:
application/json:
- schema: &542
+ schema: &539
type: object
properties:
status:
@@ -74102,13 +73654,13 @@ paths:
- description
- started_at
examples:
- default: &543
+ default: &540
value:
status: success
description: This fixes an XSS vulnerability by escaping the user
input.
started_at: '2024-02-14T12:29:18Z'
- '400': &544
+ '400': &541
description: Bad Request
content:
application/json:
@@ -74119,7 +73671,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': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -74144,29 +73696,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
responses:
'200':
description: OK
content:
application/json:
- schema: *542
+ schema: *539
examples:
- default: *543
+ default: *540
'202':
description: Accepted
content:
application/json:
- schema: *542
+ schema: *539
examples:
default:
value:
status: pending
description:
started_at: '2024-02-14T12:29:18Z'
- '400': *544
+ '400': *541
'403':
description: Response if the repository is archived, if GitHub Advanced
Security is not enabled for this repository or if rate limit is exceeded
@@ -74198,9 +73750,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
requestBody:
required: false
content:
@@ -74245,8 +73797,8 @@ paths:
value:
target_ref: refs/heads/main
sha: 178f4f6090b3fccad4a65b3e83d076a622d59652
- '400': *544
- '403': *545
+ '400': *541
+ '403': *542
'404': *6
'422':
description: Unprocessable Entity
@@ -74270,13 +73822,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
- *19
- *17
- - *546
- - *547
+ - *543
+ - *544
responses:
'200':
description: Response
@@ -74287,10 +73839,10 @@ paths:
items:
type: object
properties:
- ref: *531
- analysis_key: *548
- environment: *549
- category: *550
+ ref: *528
+ analysis_key: *545
+ environment: *546
+ category: *547
state:
type: string
description: State of a code scanning alert instance.
@@ -74305,7 +73857,7 @@ paths:
properties:
text:
type: string
- location: *551
+ location: *548
html_url:
type: string
classifications:
@@ -74313,7 +73865,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: *552
+ items: *549
examples:
default:
value:
@@ -74352,7 +73904,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -74386,25 +73938,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:
- - *459
- - *460
+ - *456
+ - *457
- *317
- *318
- *19
- *17
- - *547
+ - *544
- 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: *531
+ schema: *528
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &553
+ schema: &550
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -74425,23 +73977,23 @@ paths:
application/json:
schema:
type: array
- items: &554
+ items: &551
type: object
properties:
- ref: *531
- commit_sha: &562
+ ref: *528
+ commit_sha: &559
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: *548
+ analysis_key: *545
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *550
+ category: *547
error:
type: string
example: error reading field xyz
@@ -74465,8 +74017,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *553
- tool: *537
+ sarif_id: *550
+ tool: *534
deletable:
type: boolean
warning:
@@ -74527,7 +74079,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -74563,8 +74115,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:
- - *459
- - *460
+ - *456
+ - *457
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -74577,7 +74129,7 @@ paths:
description: Response
content:
application/json:
- schema: *554
+ schema: *551
examples:
response:
summary: application/json response
@@ -74631,7 +74183,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *539
+ '403': *536
'404': *6
'422':
description: Response if analysis could not be processed
@@ -74718,8 +74270,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:
- - *459
- - *460
+ - *456
+ - *457
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -74772,7 +74324,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': *545
+ '403': *542
'404': *6
'503': *196
x-github:
@@ -74794,8 +74346,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -74803,7 +74355,7 @@ paths:
application/json:
schema:
type: array
- items: &555
+ items: &552
title: CodeQL Database
description: A CodeQL database.
type: object
@@ -74914,7 +74466,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': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -74943,8 +74495,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:
- - *459
- - *460
+ - *456
+ - *457
- name: language
in: path
description: The language of the CodeQL database.
@@ -74956,7 +74508,7 @@ paths:
description: Response
content:
application/json:
- schema: *555
+ schema: *552
examples:
default:
value:
@@ -74988,9 +74540,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': &591
+ '302': &588
description: Found
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -75012,8 +74564,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: language
in: path
description: The language of the CodeQL database.
@@ -75023,7 +74575,7 @@ paths:
responses:
'204':
description: Response
- '403': *545
+ '403': *542
'404': *6
'503': *196
x-github:
@@ -75051,8 +74603,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -75061,7 +74613,7 @@ paths:
type: object
additionalProperties: false
properties:
- language: &556
+ language: &553
type: string
description: The language targeted by the CodeQL query
enum:
@@ -75141,7 +74693,7 @@ paths:
description: Variant analysis submitted for processing
content:
application/json:
- schema: &560
+ schema: &557
title: Variant Analysis
description: A run of a CodeQL query against one or more repositories.
type: object
@@ -75151,7 +74703,7 @@ paths:
description: The ID of the variant analysis.
controller_repo: *120
actor: *4
- query_language: *556
+ query_language: *553
query_pack_url:
type: string
description: The download url for the query pack.
@@ -75198,7 +74750,7 @@ paths:
items:
type: object
properties:
- repository: &557
+ repository: &554
title: Repository Identifier
description: Repository Identifier
type: object
@@ -75234,7 +74786,7 @@ paths:
- private
- stargazers_count
- updated_at
- analysis_status: &561
+ analysis_status: &558
type: string
description: The new status of the CodeQL variant analysis
repository task.
@@ -75266,7 +74818,7 @@ paths:
from processing. This information is only available to the user
that initiated the variant analysis.
properties:
- access_mismatch_repos: &558
+ access_mismatch_repos: &555
type: object
properties:
repository_count:
@@ -75280,7 +74832,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: *557
+ items: *554
required:
- repository_count
- repositories
@@ -75302,8 +74854,8 @@ paths:
required:
- repository_count
- repository_full_names
- no_codeql_db_repos: *558
- over_limit_repos: *558
+ no_codeql_db_repos: *555
+ over_limit_repos: *555
required:
- access_mismatch_repos
- not_found_repos
@@ -75319,7 +74871,7 @@ paths:
examples:
repositories_parameter:
summary: Response for a successful variant analysis submission
- value: &559
+ value: &556
summary: Default response
value:
id: 1
@@ -75465,10 +75017,10 @@ paths:
private: false
repository_owners:
summary: Response for a successful variant analysis submission
- value: *559
+ value: *556
repository_lists:
summary: Response for a successful variant analysis submission
- value: *559
+ value: *556
'404': *6
'422':
description: Unable to process variant analysis submission
@@ -75496,8 +75048,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:
- - *459
- - *460
+ - *456
+ - *457
- name: codeql_variant_analysis_id
in: path
description: The unique identifier of the variant analysis.
@@ -75509,9 +75061,9 @@ paths:
description: Response
content:
application/json:
- schema: *560
+ schema: *557
examples:
- default: *559
+ default: *556
'404': *6
'503': *196
x-github:
@@ -75534,7 +75086,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:
- - *459
+ - *456
- name: repo
in: path
description: The name of the controller repository.
@@ -75569,7 +75121,7 @@ paths:
type: object
properties:
repository: *120
- analysis_status: *561
+ analysis_status: *558
artifact_size_in_bytes:
type: integer
description: The size of the artifact. This is only available
@@ -75694,8 +75246,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -75780,7 +75332,7 @@ paths:
threat_model: remote
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *539
+ '403': *536
'404': *6
'503': *196
x-github:
@@ -75801,8 +75353,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -75894,7 +75446,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *545
+ '403': *542
'404': *6
'409':
description: Response if there is already a validation run in progress with
@@ -75965,8 +75517,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -75974,7 +75526,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *562
+ commit_sha: *559
ref:
type: string
description: |-
@@ -76032,7 +75584,7 @@ paths:
schema:
type: object
properties:
- id: *553
+ id: *550
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -76046,7 +75598,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': *545
+ '403': *542
'404': *6
'413':
description: Payload Too Large if the sarif field is too large
@@ -76069,8 +75621,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:
- - *459
- - *460
+ - *456
+ - *457
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -76116,7 +75668,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': *539
+ '403': *536
'404':
description: Not Found if the sarif id does not match any upload
'503': *196
@@ -76141,8 +75693,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -76223,8 +75775,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors
parameters:
- - *459
- - *460
+ - *456
+ - *457
- 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
@@ -76344,8 +75896,8 @@ paths:
parameters:
- *17
- *19
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -76659,8 +76211,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -76725,7 +76277,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -76733,7 +76285,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'400': *14
'401': *25
'403': *29
@@ -76762,8 +76314,8 @@ paths:
parameters:
- *17
- *19
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -76827,8 +76379,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:
- - *459
- - *460
+ - *456
+ - *457
- name: location
description: The location to check for available machines. Assigned by IP
if not provided.
@@ -76863,14 +76415,14 @@ paths:
type: integer
machines:
type: array
- items: &809
+ items: &804
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *564
- required: *565
+ properties: *561
+ required: *562
examples:
- default: &810
+ default: &805
value:
total_count: 2
machines:
@@ -76910,8 +76462,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ref
description: The branch or commit to check for a default devcontainer path.
If not specified, the default branch will be checked.
@@ -76995,8 +76547,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:
- - *459
- - *460
+ - *456
+ - *457
- 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
@@ -77062,8 +76614,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -77081,7 +76633,7 @@ paths:
type: integer
secrets:
type: array
- items: &569
+ items: &566
title: Codespaces Secret
description: Set repository secrets for GitHub Codespaces.
type: object
@@ -77101,7 +76653,7 @@ paths:
- created_at
- updated_at
examples:
- default: *566
+ default: *563
headers:
Link: *47
x-github:
@@ -77124,16 +76676,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *567
+ schema: *564
examples:
- default: *568
+ default: *565
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -77153,17 +76705,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'200':
description: Response
content:
application/json:
- schema: *569
+ schema: *566
examples:
- default: *570
+ default: *567
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -77183,8 +76735,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:
- - *459
- - *460
+ - *456
+ - *457
- *294
requestBody:
required: true
@@ -77237,8 +76789,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'204':
@@ -77267,8 +76819,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -77310,7 +76862,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &571
+ properties: &568
login:
type: string
example: octocat
@@ -77403,7 +76955,7 @@ paths:
user_view_type:
type: string
example: public
- required: &572
+ required: &569
- avatar_url
- events_url
- followers_url
@@ -77477,8 +77029,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:
- - *459
- - *460
+ - *456
+ - *457
- *143
responses:
'204':
@@ -77525,8 +77077,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *143
requestBody:
required: false
@@ -77553,7 +77105,7 @@ paths:
description: Response when a new invitation is created
content:
application/json:
- schema: &651
+ schema: &648
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -77782,8 +77334,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *143
responses:
'204':
@@ -77815,8 +77367,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *143
responses:
'200':
@@ -77837,8 +77389,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *571
- required: *572
+ properties: *568
+ required: *569
nullable: true
required:
- permission
@@ -77893,8 +77445,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -77904,7 +77456,7 @@ paths:
application/json:
schema:
type: array
- items: &573
+ items: &570
title: Commit Comment
description: Commit Comment
type: object
@@ -77962,7 +77514,7 @@ paths:
- created_at
- updated_at
examples:
- default: &578
+ default: &575
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78021,17 +77573,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'200':
description: Response
content:
application/json:
- schema: *573
+ schema: *570
examples:
- default: &579
+ default: &576
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78088,8 +77640,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -78112,7 +77664,7 @@ paths:
description: Response
content:
application/json:
- schema: *573
+ schema: *570
examples:
default:
value:
@@ -78163,8 +77715,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'204':
@@ -78186,8 +77738,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -78214,7 +77766,7 @@ paths:
application/json:
schema:
type: array
- items: &574
+ items: &571
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -78257,7 +77809,7 @@ paths:
- content
- created_at
examples:
- default: &655
+ default: &652
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -78302,8 +77854,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -78336,9 +77888,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: &575
+ default: &572
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -78367,9 +77919,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -78391,10 +77943,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- - &656
+ - &653
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -78449,8 +78001,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -78506,9 +78058,9 @@ paths:
application/json:
schema:
type: array
- items: *576
+ items: *573
examples:
- default: &705
+ default: &702
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -78602,9 +78154,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit
parameters:
- - *459
- - *460
- - &577
+ - *456
+ - *457
+ - &574
name: commit_sha
description: The SHA of the commit.
in: path
@@ -78676,9 +78228,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments
parameters:
- - *459
- - *460
- - *577
+ - *456
+ - *457
+ - *574
- *17
- *19
responses:
@@ -78688,9 +78240,9 @@ paths:
application/json:
schema:
type: array
- items: *573
+ items: *570
examples:
- default: *578
+ default: *575
headers:
Link: *47
x-github:
@@ -78718,9 +78270,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment
parameters:
- - *459
- - *460
- - *577
+ - *456
+ - *457
+ - *574
requestBody:
required: true
content:
@@ -78755,9 +78307,9 @@ paths:
description: Response
content:
application/json:
- schema: *573
+ schema: *570
examples:
- default: *579
+ default: *576
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -78785,9 +78337,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:
- - *459
- - *460
- - *577
+ - *456
+ - *457
+ - *574
- *17
- *19
responses:
@@ -78797,9 +78349,9 @@ paths:
application/json:
schema:
type: array
- items: *580
+ items: *577
examples:
- default: &697
+ default: &694
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -79336,11 +78888,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *19
- *17
- - &581
+ - &578
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)"
@@ -79355,9 +78907,9 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: &682
+ default: &679
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -79470,11 +79022,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:
- - *459
- - *460
- - *581
- - *582
- - *583
+ - *456
+ - *457
+ - *578
+ - *579
+ - *580
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -79508,9 +79060,9 @@ paths:
type: integer
check_runs:
type: array
- items: *523
+ items: *520
examples:
- default: *584
+ default: *581
headers:
Link: *47
x-github:
@@ -79535,9 +79087,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:
- - *459
- - *460
- - *581
+ - *456
+ - *457
+ - *578
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -79545,7 +79097,7 @@ paths:
schema:
type: integer
example: 1
- - *582
+ - *579
- *17
- *19
responses:
@@ -79563,7 +79115,7 @@ paths:
type: integer
check_suites:
type: array
- items: *528
+ items: *525
examples:
default:
value:
@@ -79763,9 +79315,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:
- - *459
- - *460
- - *581
+ - *456
+ - *457
+ - *578
- *17
- *19
responses:
@@ -79963,9 +79515,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *459
- - *460
- - *581
+ - *456
+ - *457
+ - *578
- *17
- *19
responses:
@@ -79975,7 +79527,7 @@ paths:
application/json:
schema:
type: array
- items: &758
+ items: &755
title: Status
description: The status of a commit.
type: object
@@ -80056,7 +79608,7 @@ paths:
site_admin: false
headers:
Link: *47
- '301': *465
+ '301': *462
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -80084,8 +79636,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -80114,20 +79666,20 @@ paths:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
- properties: *585
- required: *586
+ properties: *582
+ required: *583
nullable: true
code_of_conduct_file:
title: Community Health File
type: object
- properties: &587
+ properties: &584
url:
type: string
format: uri
html_url:
type: string
format: uri
- required: &588
+ required: &585
- url
- html_url
nullable: true
@@ -80141,26 +79693,26 @@ paths:
contributing:
title: Community Health File
type: object
- properties: *587
- required: *588
+ properties: *584
+ required: *585
nullable: true
readme:
title: Community Health File
type: object
- properties: *587
- required: *588
+ properties: *584
+ required: *585
nullable: true
issue_template:
title: Community Health File
type: object
- properties: *587
- required: *588
+ properties: *584
+ required: *585
nullable: true
pull_request_template:
title: Community Health File
type: object
- properties: *587
- required: *588
+ properties: *584
+ required: *585
nullable: true
required:
- code_of_conduct
@@ -80287,8 +79839,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *19
- *17
- name: basehead
@@ -80331,8 +79883,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *576
- merge_base_commit: *576
+ base_commit: *573
+ merge_base_commit: *573
status:
type: string
enum:
@@ -80352,10 +79904,10 @@ paths:
example: 6
commits:
type: array
- items: *576
+ items: *573
files:
type: array
- items: *589
+ items: *586
required:
- url
- html_url
@@ -80641,8 +80193,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: path
description: path parameter
in: path
@@ -80785,7 +80337,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &590
+ response-if-content-is-a-file: &587
summary: Response if content is a file
value:
type: file
@@ -80917,7 +80469,7 @@ paths:
- size
- type
- url
- - &710
+ - &707
title: Content File
description: Content File
type: object
@@ -81118,7 +80670,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *590
+ response-if-content-is-a-file: *587
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -81187,7 +80739,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *6
'403': *29
- '302': *591
+ '302': *588
'304': *37
x-github:
githubCloudOnly: false
@@ -81210,8 +80762,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: path
description: path parameter
in: path
@@ -81304,7 +80856,7 @@ paths:
description: Response
content:
application/json:
- schema: &592
+ schema: &589
title: File Commit
description: File Commit
type: object
@@ -81456,7 +81008,7 @@ paths:
description: Response
content:
application/json:
- schema: *592
+ schema: *589
examples:
example-for-creating-a-file:
value:
@@ -81510,7 +81062,7 @@ paths:
schema:
oneOf:
- *3
- - &633
+ - &630
description: Repository rule violation was detected
type: object
properties:
@@ -81531,7 +81083,7 @@ paths:
items:
type: object
properties:
- placeholder_id: &750
+ placeholder_id: &747
description: The ID of the push protection bypass
placeholder. This value is returned on any push
protected routes.
@@ -81563,8 +81115,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: path
description: path parameter
in: path
@@ -81625,7 +81177,7 @@ paths:
description: Response
content:
application/json:
- schema: *592
+ schema: *589
examples:
default:
value:
@@ -81680,8 +81232,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -81804,8 +81356,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *332
- *333
- *334
@@ -81817,7 +81369,7 @@ paths:
schema:
type: string
- *336
- - *593
+ - *590
- *337
- *338
- *110
@@ -81838,7 +81390,7 @@ paths:
application/json:
schema:
type: array
- items: &597
+ items: &594
type: object
description: A Dependabot alert.
properties:
@@ -81884,7 +81436,7 @@ paths:
- unknown
- direct
- transitive
- security_advisory: *594
+ security_advisory: *591
security_vulnerability: *132
url: *133
html_url: *134
@@ -81915,8 +81467,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *138
- auto_dismissed_at: *595
- dismissal_request: *596
+ auto_dismissed_at: *592
+ dismissal_request: *593
required:
- number
- state
@@ -82146,9 +81698,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *459
- - *460
- - &598
+ - *456
+ - *457
+ - &595
name: alert_number
in: path
description: |-
@@ -82163,7 +81715,7 @@ paths:
description: Response
content:
application/json:
- schema: *597
+ schema: *594
examples:
default:
value:
@@ -82276,9 +81828,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *459
- - *460
- - *598
+ - *456
+ - *457
+ - *595
requestBody:
required: true
content:
@@ -82323,7 +81875,7 @@ paths:
description: Response
content:
application/json:
- schema: *597
+ schema: *594
examples:
default:
value:
@@ -82452,8 +82004,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -82471,7 +82023,7 @@ paths:
type: integer
secrets:
type: array
- items: &601
+ items: &598
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -82524,16 +82076,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *599
+ schema: *596
examples:
- default: *600
+ default: *597
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -82553,15 +82105,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'200':
description: Response
content:
application/json:
- schema: *601
+ schema: *598
examples:
default:
value:
@@ -82587,8 +82139,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
requestBody:
required: true
@@ -82641,8 +82193,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *294
responses:
'204':
@@ -82665,8 +82217,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:
- - *459
- - *460
+ - *456
+ - *457
- 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
@@ -82826,8 +82378,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -83066,8 +82618,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -83142,7 +82694,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &602
+ metadata: &599
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -83175,7 +82727,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *602
+ metadata: *599
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -83188,7 +82740,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *602
+ metadata: *599
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -83317,8 +82869,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -83358,9 +82910,9 @@ paths:
application/json:
schema:
type: array
- items: *603
+ items: *600
examples:
- default: *604
+ default: *601
headers:
Link: *47
x-github:
@@ -83426,8 +82978,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -83508,7 +83060,7 @@ paths:
description: Response
content:
application/json:
- schema: *603
+ schema: *600
examples:
simple-example:
summary: Simple example
@@ -83581,9 +83133,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment
parameters:
- - *459
- - *460
- - &605
+ - *456
+ - *457
+ - &602
name: deployment_id
description: deployment_id parameter
in: path
@@ -83595,7 +83147,7 @@ paths:
description: Response
content:
application/json:
- schema: *603
+ schema: *600
examples:
default:
value:
@@ -83660,9 +83212,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment
parameters:
- - *459
- - *460
- - *605
+ - *456
+ - *457
+ - *602
responses:
'204':
description: Response
@@ -83684,9 +83236,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses
parameters:
- - *459
- - *460
- - *605
+ - *456
+ - *457
+ - *602
- *17
- *19
responses:
@@ -83696,7 +83248,7 @@ paths:
application/json:
schema:
type: array
- items: &606
+ items: &603
title: Deployment Status
description: The status of a deployment.
type: object
@@ -83857,9 +83409,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status
parameters:
- - *459
- - *460
- - *605
+ - *456
+ - *457
+ - *602
requestBody:
required: true
content:
@@ -83934,9 +83486,9 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *603
examples:
- default: &607
+ default: &604
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -83992,9 +83544,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status
parameters:
- - *459
- - *460
- - *605
+ - *456
+ - *457
+ - *602
- name: status_id
in: path
required: true
@@ -84005,9 +83557,9 @@ paths:
description: Response
content:
application/json:
- schema: *606
+ schema: *603
examples:
- default: *607
+ default: *604
'404': *6
x-github:
githubCloudOnly: false
@@ -84034,12 +83586,12 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
+ - *605
+ - *606
+ - *607
- *608
- - *609
- - *610
- - *611
- *17
- *19
responses:
@@ -84049,9 +83601,9 @@ paths:
application/json:
schema:
type: array
- items: *612
+ items: *609
examples:
- default: *613
+ default: *610
'404': *6
'403': *29
'500': *40
@@ -84075,8 +83627,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84088,7 +83640,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *612
+ schema: *609
examples:
default:
value:
@@ -84144,8 +83696,8 @@ paths:
category: code-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84204,12 +83756,12 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
+ - *605
+ - *606
+ - *607
- *608
- - *609
- - *610
- - *611
- *17
- *19
responses:
@@ -84219,9 +83771,9 @@ paths:
application/json:
schema:
type: array
- items: *614
+ items: *611
examples:
- default: *615
+ default: *612
'404': *6
'403': *29
'500': *40
@@ -84245,8 +83797,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84258,7 +83810,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *614
+ schema: *611
examples:
default:
value:
@@ -84309,8 +83861,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84348,7 +83900,7 @@ paths:
description: The created dismissal request.
content:
application/json:
- schema: *614
+ schema: *611
examples:
default:
value:
@@ -84399,8 +83951,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84471,8 +84023,8 @@ paths:
category: dependabot
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84505,8 +84057,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *103
- *104
- *105
@@ -84520,9 +84072,9 @@ paths:
application/json:
schema:
type: array
- items: *616
+ items: *613
examples:
- default: *617
+ default: *614
'404': *6
'403': *29
'500': *40
@@ -84547,8 +84099,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84560,7 +84112,7 @@ paths:
description: A single dismissal request.
content:
application/json:
- schema: *616
+ schema: *613
examples:
default:
value:
@@ -84618,8 +84170,8 @@ paths:
category: secret-scanning
subcategory: alert-dismissal-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: alert_number
in: path
required: true
@@ -84688,8 +84240,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -84746,8 +84298,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -84764,7 +84316,7 @@ paths:
type: integer
environments:
type: array
- items: &619
+ items: &616
title: Environment
description: Details of a deployment environment
type: object
@@ -84816,7 +84368,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &621
+ wait_timer: &618
type: integer
example: 30
description: The amount of time to delay a job after
@@ -84853,7 +84405,7 @@ paths:
items:
type: object
properties:
- type: *618
+ type: *615
reviewer:
anyOf:
- *4
@@ -84877,7 +84429,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &622
+ deployment_branch_policy: &619
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -84993,9 +84545,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment
parameters:
- - *459
- - *460
- - &620
+ - *456
+ - *457
+ - &617
name: environment_name
in: path
required: true
@@ -85008,9 +84560,9 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: &623
+ default: &620
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -85094,9 +84646,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
requestBody:
required: false
content:
@@ -85105,7 +84657,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *621
+ wait_timer: *618
prevent_self_review:
type: boolean
example: false
@@ -85122,13 +84674,13 @@ paths:
items:
type: object
properties:
- type: *618
+ type: *615
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *622
+ deployment_branch_policy: *619
additionalProperties: false
examples:
default:
@@ -85148,9 +84700,9 @@ paths:
description: Response
content:
application/json:
- schema: *619
+ schema: *616
examples:
- default: *623
+ default: *620
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -85174,9 +84726,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
responses:
'204':
description: Default response
@@ -85201,9 +84753,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *17
- *19
responses:
@@ -85221,7 +84773,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &624
+ items: &621
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -85278,9 +84830,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
requestBody:
required: true
content:
@@ -85326,9 +84878,9 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
- example-wildcard: &625
+ example-wildcard: &622
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -85370,10 +84922,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *459
- - *460
- - *620
- - &626
+ - *456
+ - *457
+ - *617
+ - &623
name: branch_policy_id
in: path
required: true
@@ -85385,9 +84937,9 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
- default: *625
+ default: *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85406,10 +84958,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *459
- - *460
- - *620
- - *626
+ - *456
+ - *457
+ - *617
+ - *623
requestBody:
required: true
content:
@@ -85437,9 +84989,9 @@ paths:
description: Response
content:
application/json:
- schema: *624
+ schema: *621
examples:
- default: *625
+ default: *622
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85458,10 +85010,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *459
- - *460
- - *620
- - *626
+ - *456
+ - *457
+ - *617
+ - *623
responses:
'204':
description: Response
@@ -85486,9 +85038,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:
- - *620
- - *460
- - *459
+ - *617
+ - *457
+ - *456
responses:
'200':
description: List of deployment protection rules
@@ -85504,7 +85056,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &627
+ items: &624
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -85523,7 +85075,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &628
+ app: &625
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -85622,9 +85174,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:
- - *620
- - *460
- - *459
+ - *617
+ - *457
+ - *456
requestBody:
content:
application/json:
@@ -85645,9 +85197,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: &629
+ default: &626
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -85682,9 +85234,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:
- - *620
- - *460
- - *459
+ - *617
+ - *457
+ - *456
- *19
- *17
responses:
@@ -85703,7 +85255,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *628
+ items: *625
examples:
default:
value:
@@ -85738,10 +85290,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:
- - *459
- - *460
- - *620
- - &630
+ - *456
+ - *457
+ - *617
+ - &627
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -85753,9 +85305,9 @@ paths:
description: Response
content:
application/json:
- schema: *627
+ schema: *624
examples:
- default: *629
+ default: *626
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85776,10 +85328,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:
- - *620
- - *460
- - *459
- - *630
+ - *617
+ - *457
+ - *456
+ - *627
responses:
'204':
description: Response
@@ -85805,9 +85357,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *17
- *19
responses:
@@ -85825,9 +85377,9 @@ paths:
type: integer
secrets:
type: array
- items: *490
+ items: *487
examples:
- default: *491
+ default: *488
headers:
Link: *47
x-github:
@@ -85852,17 +85404,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
responses:
'200':
description: Response
content:
application/json:
- schema: *492
+ schema: *489
examples:
- default: *493
+ default: *490
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85884,18 +85436,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *294
responses:
'200':
description: Response
content:
application/json:
- schema: *490
+ schema: *487
examples:
- default: *631
+ default: *628
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -85917,9 +85469,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *294
requestBody:
required: true
@@ -85977,9 +85529,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *294
responses:
'204':
@@ -86005,10 +85557,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables
parameters:
- - *459
- - *460
- - *620
- - *477
+ - *456
+ - *457
+ - *617
+ - *474
- *19
responses:
'200':
@@ -86025,9 +85577,9 @@ paths:
type: integer
variables:
type: array
- items: *494
+ items: *491
examples:
- default: *495
+ default: *492
headers:
Link: *47
x-github:
@@ -86050,9 +85602,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
requestBody:
required: true
content:
@@ -86104,18 +85656,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable
parameters:
- - *459
- - *460
- - *620
+ - *456
+ - *457
+ - *617
- *297
responses:
'200':
description: Response
content:
application/json:
- schema: *494
+ schema: *491
examples:
- default: *632
+ default: *629
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86136,10 +85688,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
- - *620
+ - *617
requestBody:
required: true
content:
@@ -86181,10 +85733,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *297
- - *620
+ - *617
responses:
'204':
description: Response
@@ -86206,8 +85758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -86275,8 +85827,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -86435,8 +85987,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -86468,9 +86020,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
+ default: *463
'400': *14
'422': *15
'403': *29
@@ -86491,8 +86043,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -86552,7 +86104,7 @@ paths:
schema:
oneOf:
- *259
- - *633
+ - *630
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -86577,8 +86129,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: file_sha
in: path
required: true
@@ -86677,8 +86229,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -86787,7 +86339,7 @@ paths:
description: Response
content:
application/json:
- schema: &634
+ schema: &631
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -87001,15 +86553,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object
parameters:
- - *459
- - *460
- - *577
+ - *456
+ - *457
+ - *574
responses:
'200':
description: Response
content:
application/json:
- schema: *634
+ schema: *631
examples:
default:
value:
@@ -87065,9 +86617,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references
parameters:
- - *459
- - *460
- - &635
+ - *456
+ - *457
+ - &632
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.
@@ -87084,7 +86636,7 @@ paths:
application/json:
schema:
type: array
- items: &636
+ items: &633
title: Git Reference
description: Git references within a repository
type: object
@@ -87159,17 +86711,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference
parameters:
- - *459
- - *460
- - *635
+ - *456
+ - *457
+ - *632
responses:
'200':
description: Response
content:
application/json:
- schema: *636
+ schema: *633
examples:
- default: &637
+ default: &634
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -87198,8 +86750,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -87228,9 +86780,9 @@ paths:
description: Response
content:
application/json:
- schema: *636
+ schema: *633
examples:
- default: *637
+ default: *634
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -87256,9 +86808,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference
parameters:
- - *459
- - *460
- - *635
+ - *456
+ - *457
+ - *632
requestBody:
required: true
content:
@@ -87287,9 +86839,9 @@ paths:
description: Response
content:
application/json:
- schema: *636
+ schema: *633
examples:
- default: *637
+ default: *634
'422': *15
'409': *119
x-github:
@@ -87307,9 +86859,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference
parameters:
- - *459
- - *460
- - *635
+ - *456
+ - *457
+ - *632
responses:
'204':
description: Response
@@ -87364,8 +86916,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -87432,7 +86984,7 @@ paths:
description: Response
content:
application/json:
- schema: &639
+ schema: &636
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -87483,7 +87035,7 @@ paths:
- sha
- type
- url
- verification: *638
+ verification: *635
required:
- sha
- url
@@ -87493,7 +87045,7 @@ paths:
- tag
- message
examples:
- default: &640
+ default: &637
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -87566,8 +87118,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: tag_sha
in: path
required: true
@@ -87578,9 +87130,9 @@ paths:
description: Response
content:
application/json:
- schema: *639
+ schema: *636
examples:
- default: *640
+ default: *637
'404': *6
'409': *119
x-github:
@@ -87604,8 +87156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -87678,7 +87230,7 @@ paths:
description: Response
content:
application/json:
- schema: &641
+ schema: &638
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -87774,8 +87326,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -87798,7 +87350,7 @@ paths:
description: Response
content:
application/json:
- schema: *641
+ schema: *638
examples:
default-response:
summary: Default response
@@ -87857,8 +87409,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -87868,7 +87420,7 @@ paths:
application/json:
schema:
type: array
- items: &642
+ items: &639
title: Webhook
description: Webhooks for repositories.
type: object
@@ -87922,7 +87474,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &901
+ last_response: &896
title: Hook Response
type: object
properties:
@@ -87996,8 +87548,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -88049,9 +87601,9 @@ paths:
description: Response
content:
application/json:
- schema: *642
+ schema: *639
examples:
- default: &643
+ default: &640
value:
type: Repository
id: 12345678
@@ -88099,17 +87651,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'200':
description: Response
content:
application/json:
- schema: *642
+ schema: *639
examples:
- default: *643
+ default: *640
'404': *6
x-github:
githubCloudOnly: false
@@ -88129,8 +87681,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
requestBody:
required: true
@@ -88176,9 +87728,9 @@ paths:
description: Response
content:
application/json:
- schema: *642
+ schema: *639
examples:
- default: *643
+ default: *640
'422': *15
'404': *6
x-github:
@@ -88199,8 +87751,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'204':
@@ -88225,8 +87777,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:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'200':
@@ -88254,8 +87806,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:
- - *459
- - *460
+ - *456
+ - *457
- *348
requestBody:
required: false
@@ -88300,8 +87852,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
- *17
- *349
@@ -88333,8 +87885,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:
- - *459
- - *460
+ - *456
+ - *457
- *348
- *16
responses:
@@ -88363,8 +87915,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:
- - *459
- - *460
+ - *456
+ - *457
- *348
- *16
responses:
@@ -88388,8 +87940,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'204':
@@ -88415,8 +87967,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *348
responses:
'204':
@@ -88440,8 +87992,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response if immutable releases are enabled
@@ -88487,8 +88039,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204': *155
'409': *119
@@ -88508,8 +88060,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204': *155
'409': *119
@@ -88566,14 +88118,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &644
+ schema: &641
title: Import
description: A repository import from an external source.
type: object
@@ -88672,7 +88224,7 @@ paths:
- html_url
- authors_url
examples:
- default: &647
+ default: &644
value:
vcs: subversion
use_lfs: true
@@ -88688,7 +88240,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': &645
+ '503': &642
description: Unavailable due to service under maintenance.
content:
application/json:
@@ -88717,8 +88269,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -88766,7 +88318,7 @@ paths:
description: Response
content:
application/json:
- schema: *644
+ schema: *641
examples:
default:
value:
@@ -88791,7 +88343,7 @@ paths:
type: string
'422': *15
'404': *6
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88819,8 +88371,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -88869,7 +88421,7 @@ paths:
description: Response
content:
application/json:
- schema: *644
+ schema: *641
examples:
example-1:
summary: Example 1
@@ -88917,7 +88469,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': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88940,12 +88492,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -88971,9 +88523,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors
parameters:
- - *459
- - *460
- - &831
+ - *456
+ - *457
+ - &826
name: since
description: A user ID. Only return users with an ID greater than this ID.
in: query
@@ -88987,7 +88539,7 @@ paths:
application/json:
schema:
type: array
- items: &646
+ items: &643
title: Porter Author
description: Porter Author
type: object
@@ -89041,7 +88593,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': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89066,8 +88618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: author_id
in: path
required: true
@@ -89097,7 +88649,7 @@ paths:
description: Response
content:
application/json:
- schema: *646
+ schema: *643
examples:
default:
value:
@@ -89110,7 +88662,7 @@ paths:
import_url: https://api.github.com/repos/octocat/socm/import
'422': *15
'404': *6
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89134,8 +88686,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -89176,7 +88728,7 @@ paths:
path: foo/bar/3
oid: c20ad4d76fe97759aa27a0c99bff6710
size: 12582912
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89204,8 +88756,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -89232,11 +88784,11 @@ paths:
description: Response
content:
application/json:
- schema: *644
+ schema: *641
examples:
- default: *647
+ default: *644
'422': *15
- '503': *645
+ '503': *642
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -89259,8 +88811,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -89268,8 +88820,8 @@ paths:
application/json:
schema: *22
examples:
- default: *648
- '301': *465
+ default: *645
+ '301': *462
'404': *6
x-github:
githubCloudOnly: false
@@ -89289,8 +88841,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -89303,7 +88855,7 @@ paths:
properties: {}
additionalProperties: false
examples:
- default: &650
+ default: &647
value:
limit: collaborators_only
origin: repository
@@ -89328,13 +88880,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
application/json:
- schema: *649
+ schema: *646
examples:
default:
summary: Example request body
@@ -89348,7 +88900,7 @@ paths:
application/json:
schema: *366
examples:
- default: *650
+ default: *647
'409':
description: Response
x-github:
@@ -89370,8 +88922,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -89394,8 +88946,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -89405,9 +88957,9 @@ paths:
application/json:
schema:
type: array
- items: *651
+ items: *648
examples:
- default: &824
+ default: &819
value:
- id: 1
repository:
@@ -89538,8 +89090,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *370
requestBody:
required: false
@@ -89569,7 +89121,7 @@ paths:
description: Response
content:
application/json:
- schema: *651
+ schema: *648
examples:
default:
value:
@@ -89700,8 +89252,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *370
responses:
'204':
@@ -89733,8 +89285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues
parameters:
- - *459
- - *460
+ - *456
+ - *457
- 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
@@ -89807,7 +89359,7 @@ paths:
type: array
items: *221
examples:
- default: &663
+ default: &660
value:
- id: 1
node_id: MDU6SXNzdWUx
@@ -89955,7 +89507,7 @@ paths:
state_reason: completed
headers:
Link: *47
- '301': *465
+ '301': *462
'422': *15
'404': *6
x-github:
@@ -89984,8 +89536,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -90069,7 +89621,7 @@ paths:
application/json:
schema: *221
examples:
- default: &660
+ default: &657
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -90225,7 +89777,7 @@ paths:
'422': *15
'503': *196
'404': *6
- '410': *652
+ '410': *649
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -90253,8 +89805,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *245
- name: direction
description: Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -90275,9 +89827,9 @@ paths:
application/json:
schema:
type: array
- items: *653
+ items: *650
examples:
- default: &662
+ default: &659
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -90335,17 +89887,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'200':
description: Response
content:
application/json:
- schema: *653
+ schema: *650
examples:
- default: &654
+ default: &651
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -90399,8 +89951,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -90423,9 +89975,9 @@ paths:
description: Response
content:
application/json:
- schema: *653
+ schema: *650
examples:
- default: *654
+ default: *651
'422': *15
x-github:
githubCloudOnly: false
@@ -90443,8 +89995,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'204':
@@ -90465,8 +90017,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -90493,9 +90045,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *655
+ default: *652
headers:
Link: *47
'404': *6
@@ -90516,8 +90068,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -90550,16 +90102,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'201':
description: Reaction created
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -90581,10 +90133,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- - *656
+ - *653
responses:
'204':
description: Response
@@ -90604,8 +90156,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -90615,7 +90167,7 @@ paths:
application/json:
schema:
type: array
- items: &659
+ items: &656
title: Issue Event
description: Issue Event
type: object
@@ -90658,8 +90210,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *657
- required: *658
+ properties: *654
+ required: *655
nullable: true
label:
title: Issue Event Label
@@ -90966,8 +90518,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: event_id
in: path
required: true
@@ -90978,7 +90530,7 @@ paths:
description: Response
content:
application/json:
- schema: *659
+ schema: *656
examples:
default:
value:
@@ -91170,7 +90722,7 @@ paths:
author_association: COLLABORATOR
state_reason: completed
'404': *6
- '410': *652
+ '410': *649
'403': *29
x-github:
githubCloudOnly: false
@@ -91204,9 +90756,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue
parameters:
- - *459
- - *460
- - &661
+ - *456
+ - *457
+ - &658
name: issue_number
description: The number that identifies the issue.
in: path
@@ -91220,10 +90772,10 @@ paths:
application/json:
schema: *221
examples:
- default: *660
- '301': *465
+ default: *657
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
'304': *37
x-github:
githubCloudOnly: false
@@ -91248,9 +90800,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -91356,13 +90908,13 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
'422': *15
'503': *196
'403': *29
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91380,9 +90932,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -91410,7 +90962,7 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91426,9 +90978,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
content:
application/json:
@@ -91455,7 +91007,7 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91477,9 +91029,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- name: assignee
in: path
required: true
@@ -91519,9 +91071,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *228
- *17
- *19
@@ -91532,13 +91084,13 @@ paths:
application/json:
schema:
type: array
- items: *653
+ items: *650
examples:
- default: *662
+ default: *659
headers:
Link: *47
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91567,9 +91119,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -91591,16 +91143,16 @@ paths:
description: Response
content:
application/json:
- schema: *653
+ schema: *650
examples:
- default: *654
+ default: *651
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
schema:
type: string
'403': *29
- '410': *652
+ '410': *649
'422': *15
'404': *6
x-github:
@@ -91628,9 +91180,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -91642,12 +91194,12 @@ paths:
type: array
items: *221
examples:
- default: *663
+ default: *660
headers:
Link: *47
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91675,9 +91227,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -91701,15 +91253,15 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by
schema:
type: string
- '301': *465
+ '301': *462
'403': *29
- '410': *652
+ '410': *649
'422': *15
'404': *6
x-github:
@@ -91740,9 +91292,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- name: issue_id
in: path
description: The id of the blocking issue to remove as a dependency
@@ -91756,13 +91308,13 @@ paths:
application/json:
schema: *221
examples:
- default: *660
- '301': *465
+ default: *657
+ '301': *462
'400': *14
'401': *25
'403': *29
'404': *6
- '410': *652
+ '410': *649
x-github:
triggersNotification: true
githubCloudOnly: false
@@ -91788,9 +91340,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -91802,12 +91354,12 @@ paths:
type: array
items: *221
examples:
- default: *663
+ default: *660
headers:
Link: *47
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -91824,9 +91376,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -91840,7 +91392,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &665
+ - &662
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -91894,7 +91446,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &666
+ - &663
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -92030,7 +91582,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &667
+ - &664
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -92081,7 +91633,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &668
+ - &665
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -92132,7 +91684,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &669
+ - &666
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -92186,7 +91738,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &670
+ - &667
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -92233,7 +91785,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &671
+ - &668
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -92280,7 +91832,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &672
+ - &669
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -92340,7 +91892,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &673
+ - &670
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -92388,7 +91940,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &674
+ - &671
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -92454,7 +92006,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &675
+ - &672
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -92520,7 +92072,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &676
+ - &673
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -92586,7 +92138,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &677
+ - &674
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -92677,7 +92229,7 @@ paths:
color: red
headers:
Link: *47
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92694,9 +92246,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -92708,7 +92260,7 @@ paths:
type: array
items: *220
examples:
- default: &664
+ default: &661
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -92726,9 +92278,9 @@ paths:
default: false
headers:
Link: *47
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92745,9 +92297,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -92808,10 +92360,10 @@ paths:
type: array
items: *220
examples:
- default: *664
- '301': *465
+ default: *661
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
'422': *15
x-github:
githubCloudOnly: false
@@ -92828,9 +92380,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -92892,10 +92444,10 @@ paths:
type: array
items: *220
examples:
- default: *664
- '301': *465
+ default: *661
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
'422': *15
x-github:
githubCloudOnly: false
@@ -92912,15 +92464,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
responses:
'204':
description: Response
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92939,9 +92491,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- name: name
in: path
required: true
@@ -92965,9 +92517,9 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *465
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -92987,9 +92539,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: false
content:
@@ -93017,7 +92569,7 @@ paths:
'204':
description: Response
'403': *29
- '410': *652
+ '410': *649
'404': *6
'422': *15
x-github:
@@ -93035,9 +92587,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
responses:
'204':
description: Response
@@ -93067,9 +92619,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
responses:
'200':
description: Response
@@ -93077,10 +92629,10 @@ paths:
application/json:
schema: *221
examples:
- default: *660
- '301': *465
+ default: *657
+ '301': *462
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93097,9 +92649,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -93125,13 +92677,13 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *655
+ default: *652
headers:
Link: *47
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93149,9 +92701,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -93183,16 +92735,16 @@ paths:
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'201':
description: Response
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -93214,10 +92766,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *459
- - *460
- - *661
- - *656
+ - *456
+ - *457
+ - *658
+ - *653
responses:
'204':
description: Response
@@ -93246,9 +92798,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -93272,7 +92824,7 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue
@@ -93305,9 +92857,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -93319,11 +92871,11 @@ paths:
type: array
items: *221
examples:
- default: *663
+ default: *660
headers:
Link: *47
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -93351,9 +92903,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -93382,14 +92934,14 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1
schema:
type: string
'403': *29
- '410': *652
+ '410': *649
'422': *15
'404': *6
x-github:
@@ -93409,9 +92961,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
requestBody:
required: true
content:
@@ -93444,7 +92996,7 @@ paths:
application/json:
schema: *221
examples:
- default: *660
+ default: *657
'403': *29
'404': *6
'422': *7
@@ -93466,9 +93018,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *459
- - *460
- - *661
+ - *456
+ - *457
+ - *658
- *17
- *19
responses:
@@ -93483,6 +93035,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *662
+ - *663
+ - *664
- *665
- *666
- *667
@@ -93493,9 +93048,6 @@ paths:
- *672
- *673
- *674
- - *675
- - *676
- - *677
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -93804,7 +93356,7 @@ paths:
type: string
comments:
type: array
- items: &699
+ items: &696
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -94019,7 +93571,7 @@ paths:
type: string
comments:
type: array
- items: *573
+ items: *570
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -94308,7 +93860,7 @@ paths:
headers:
Link: *47
'404': *6
- '410': *652
+ '410': *649
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -94325,8 +93877,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -94336,7 +93888,7 @@ paths:
application/json:
schema:
type: array
- items: &678
+ items: &675
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -94402,8 +93954,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -94439,9 +93991,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *675
examples:
- default: &679
+ default: &676
value:
id: 1
key: ssh-rsa AAA...
@@ -94475,9 +94027,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *459
- - *460
- - &680
+ - *456
+ - *457
+ - &677
name: key_id
description: The unique identifier of the key.
in: path
@@ -94489,9 +94041,9 @@ paths:
description: Response
content:
application/json:
- schema: *678
+ schema: *675
examples:
- default: *679
+ default: *676
'404': *6
x-github:
githubCloudOnly: false
@@ -94509,9 +94061,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *459
- - *460
- - *680
+ - *456
+ - *457
+ - *677
responses:
'204':
description: Response
@@ -94531,8 +94083,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -94544,7 +94096,7 @@ paths:
type: array
items: *220
examples:
- default: *664
+ default: *661
headers:
Link: *47
'404': *6
@@ -94565,8 +94117,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -94604,7 +94156,7 @@ paths:
application/json:
schema: *220
examples:
- default: &681
+ default: &678
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -94636,8 +94188,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: name
in: path
required: true
@@ -94650,7 +94202,7 @@ paths:
application/json:
schema: *220
examples:
- default: *681
+ default: *678
'404': *6
x-github:
githubCloudOnly: false
@@ -94667,8 +94219,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: name
in: path
required: true
@@ -94733,8 +94285,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: name
in: path
required: true
@@ -94760,8 +94312,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -94797,8 +94349,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'202': *39
'403':
@@ -94826,8 +94378,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -94853,9 +94405,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *459
- - *460
- - *546
+ - *456
+ - *457
+ - *543
responses:
'200':
description: Response
@@ -95000,8 +94552,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95066,8 +94618,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95101,9 +94653,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *682
+ default: *679
'204':
description: Response when already merged
'404':
@@ -95128,8 +94680,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -95170,7 +94722,7 @@ paths:
application/json:
schema:
type: array
- items: &683
+ items: &680
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -95231,8 +94783,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95272,9 +94824,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: &684
+ default: &681
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -95333,9 +94885,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone
parameters:
- - *459
- - *460
- - &685
+ - *456
+ - *457
+ - &682
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -95347,9 +94899,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: *684
+ default: *681
'404': *6
x-github:
githubCloudOnly: false
@@ -95366,9 +94918,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone
parameters:
- - *459
- - *460
- - *685
+ - *456
+ - *457
+ - *682
requestBody:
required: false
content:
@@ -95406,9 +94958,9 @@ paths:
description: Response
content:
application/json:
- schema: *683
+ schema: *680
examples:
- default: *684
+ default: *681
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -95424,9 +94976,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone
parameters:
- - *459
- - *460
- - *685
+ - *456
+ - *457
+ - *682
responses:
'204':
description: Response
@@ -95447,9 +94999,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *459
- - *460
- - *685
+ - *456
+ - *457
+ - *682
- *17
- *19
responses:
@@ -95461,7 +95013,7 @@ paths:
type: array
items: *220
examples:
- default: *664
+ default: *661
headers:
Link: *47
x-github:
@@ -95480,12 +95032,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *459
- - *460
- - *686
- - *687
+ - *456
+ - *457
+ - *683
+ - *684
- *228
- - *688
+ - *685
- *17
- *19
responses:
@@ -95497,7 +95049,7 @@ paths:
type: array
items: *248
examples:
- default: *689
+ default: *686
headers:
Link: *47
x-github:
@@ -95521,8 +95073,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -95580,14 +95132,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: &690
+ schema: &687
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -95712,7 +95264,7 @@ paths:
- custom_404
- public
examples:
- default: &691
+ default: &688
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -95753,8 +95305,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95808,9 +95360,9 @@ paths:
description: Response
content:
application/json:
- schema: *690
+ schema: *687
examples:
- default: *691
+ default: *688
'422': *15
'409': *119
x-github:
@@ -95833,8 +95385,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -95941,8 +95493,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -95968,8 +95520,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -95979,7 +95531,7 @@ paths:
application/json:
schema:
type: array
- items: &692
+ items: &689
title: Page Build
description: Page Build
type: object
@@ -96073,8 +95625,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'201':
description: Response
@@ -96119,16 +95671,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *692
+ schema: *689
examples:
- default: &693
+ default: &690
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -96176,8 +95728,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: build_id
in: path
required: true
@@ -96188,9 +95740,9 @@ paths:
description: Response
content:
application/json:
- schema: *692
+ schema: *689
examples:
- default: *693
+ default: *690
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -96210,8 +95762,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -96316,9 +95868,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *459
- - *460
- - &694
+ - *456
+ - *457
+ - &691
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -96376,9 +95928,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *459
- - *460
- - *694
+ - *456
+ - *457
+ - *691
responses:
'204': *155
'404': *6
@@ -96405,8 +95957,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -96664,8 +96216,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Private vulnerability reporting status
@@ -96702,8 +96254,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204': *155
'422': *14
@@ -96724,8 +96276,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204': *155
'422': *14
@@ -96747,8 +96299,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -96758,7 +96310,7 @@ paths:
type: array
items: *156
examples:
- default: *695
+ default: *692
'403': *29
'404': *6
x-github:
@@ -96780,8 +96332,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -96797,7 +96349,7 @@ paths:
required:
- properties
examples:
- default: *696
+ default: *693
responses:
'204':
description: No Content when custom property values are successfully created
@@ -96835,8 +96387,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -96896,9 +96448,9 @@ paths:
application/json:
schema:
type: array
- items: *580
+ items: *577
examples:
- default: *697
+ default: *694
headers:
Link: *47
'304': *37
@@ -96930,8 +96482,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -96996,7 +96548,7 @@ paths:
description: Response
content:
application/json:
- schema: &701
+ schema: &698
type: object
title: Pull Request
description: Pull requests let you tell others about changes you've
@@ -97210,7 +96762,7 @@ paths:
- review_comment
- self
author_association: *222
- auto_merge: *698
+ auto_merge: *695
draft:
description: Indicates whether or not the pull request is a draft.
example: false
@@ -97302,7 +96854,7 @@ paths:
- merged_by
- review_comments
examples:
- default: &702
+ default: &699
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -97829,8 +97381,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sort
in: query
required: false
@@ -97859,9 +97411,9 @@ paths:
application/json:
schema:
type: array
- items: *699
+ items: *696
examples:
- default: &704
+ default: &701
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -97938,17 +97490,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'200':
description: Response
content:
application/json:
- schema: *699
+ schema: *696
examples:
- default: &700
+ default: &697
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -98023,8 +97575,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:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -98047,9 +97599,9 @@ paths:
description: Response
content:
application/json:
- schema: *699
+ schema: *696
examples:
- default: *700
+ default: *697
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -98065,8 +97617,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:
- - *459
- - *460
+ - *456
+ - *457
- *237
responses:
'204':
@@ -98088,8 +97640,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:
- - *459
- - *460
+ - *456
+ - *457
- *237
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
@@ -98116,9 +97668,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *655
+ default: *652
headers:
Link: *47
'404': *6
@@ -98139,8 +97691,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:
- - *459
- - *460
+ - *456
+ - *457
- *237
requestBody:
required: true
@@ -98173,16 +97725,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'201':
description: Reaction created
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -98204,10 +97756,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *237
- - *656
+ - *653
responses:
'204':
description: Response
@@ -98250,9 +97802,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request
parameters:
- - *459
- - *460
- - &703
+ - *456
+ - *457
+ - &700
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -98265,9 +97817,9 @@ paths:
to fetch diff and patch formats.
content:
application/json:
- schema: *701
+ schema: *698
examples:
- default: *702
+ default: *699
'304': *37
'404': *6
'406':
@@ -98302,9 +97854,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -98346,9 +97898,9 @@ paths:
description: Response
content:
application/json:
- schema: *701
+ schema: *698
examples:
- default: *702
+ default: *699
'422': *15
'403': *29
x-github:
@@ -98370,9 +97922,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: true
content:
@@ -98434,7 +97986,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -98442,7 +97994,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'401': *25
'403': *29
'404': *6
@@ -98472,9 +98024,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *245
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
@@ -98495,9 +98047,9 @@ paths:
application/json:
schema:
type: array
- items: *699
+ items: *696
examples:
- default: *704
+ default: *701
headers:
Link: *47
x-github:
@@ -98530,9 +98082,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: true
content:
@@ -98637,7 +98189,7 @@ paths:
description: Response
content:
application/json:
- schema: *699
+ schema: *696
examples:
example-for-a-multi-line-comment:
value:
@@ -98725,9 +98277,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *237
requestBody:
required: true
@@ -98750,7 +98302,7 @@ paths:
description: Response
content:
application/json:
- schema: *699
+ schema: *696
examples:
default:
value:
@@ -98836,9 +98388,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *17
- *19
responses:
@@ -98848,9 +98400,9 @@ paths:
application/json:
schema:
type: array
- items: *576
+ items: *573
examples:
- default: *705
+ default: *702
headers:
Link: *47
x-github:
@@ -98880,9 +98432,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *17
- *19
responses:
@@ -98892,7 +98444,7 @@ paths:
application/json:
schema:
type: array
- items: *589
+ items: *586
examples:
default:
value:
@@ -98930,9 +98482,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
responses:
'204':
description: Response if pull request has been merged
@@ -98955,9 +98507,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -99068,9 +98620,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
responses:
'200':
description: Response
@@ -99145,9 +98697,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -99184,7 +98736,7 @@ paths:
description: Response
content:
application/json:
- schema: *580
+ schema: *577
examples:
default:
value:
@@ -99720,9 +99272,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: true
content:
@@ -99756,7 +99308,7 @@ paths:
description: Response
content:
application/json:
- schema: *580
+ schema: *577
examples:
default:
value:
@@ -100261,9 +99813,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
- *17
- *19
responses:
@@ -100273,7 +99825,7 @@ paths:
application/json:
schema:
type: array
- items: &706
+ items: &703
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -100424,9 +99976,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -100512,9 +100064,9 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
- default: &708
+ default: &705
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -100577,10 +100129,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - &707
+ - *456
+ - *457
+ - *700
+ - &704
name: review_id
description: The unique identifier of the review.
in: path
@@ -100592,9 +100144,9 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
- default: &709
+ default: &706
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -100653,10 +100205,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
requestBody:
required: true
content:
@@ -100679,7 +100231,7 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
default:
value:
@@ -100741,18 +100293,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
responses:
'200':
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
- default: *708
+ default: *705
'422': *7
'404': *6
x-github:
@@ -100779,10 +100331,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
- *17
- *19
responses:
@@ -101017,10 +100569,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
requestBody:
required: true
content:
@@ -101048,7 +100600,7 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
default:
value:
@@ -101111,10 +100663,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *459
- - *460
- - *703
- - *707
+ - *456
+ - *457
+ - *700
+ - *704
requestBody:
required: true
content:
@@ -101149,9 +100701,9 @@ paths:
description: Response
content:
application/json:
- schema: *706
+ schema: *703
examples:
- default: *709
+ default: *706
'404': *6
'422': *7
'403': *29
@@ -101173,9 +100725,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *459
- - *460
- - *703
+ - *456
+ - *457
+ - *700
requestBody:
required: false
content:
@@ -101238,8 +100790,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -101252,9 +100804,9 @@ paths:
description: Response
content:
application/json:
- schema: *710
+ schema: *707
examples:
- default: &711
+ default: &708
value:
type: file
encoding: base64
@@ -101296,8 +100848,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:
- - *459
- - *460
+ - *456
+ - *457
- name: dir
description: The alternate path to look for a README file
in: path
@@ -101317,9 +100869,9 @@ paths:
description: Response
content:
application/json:
- schema: *710
+ schema: *707
examples:
- default: *711
+ default: *708
'404': *6
'422': *15
x-github:
@@ -101341,8 +100893,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -101352,7 +100904,7 @@ paths:
application/json:
schema:
type: array
- items: *712
+ items: *709
examples:
default:
value:
@@ -101446,8 +100998,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -101523,9 +101075,9 @@ paths:
description: Response
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: &716
+ default: &713
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -101630,9 +101182,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset
parameters:
- - *459
- - *460
- - &714
+ - *456
+ - *457
+ - &711
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -101644,9 +101196,9 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
- default: &715
+ default: &712
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1
browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip
@@ -101681,7 +101233,7 @@ paths:
type: User
site_admin: false
'404': *6
- '302': *591
+ '302': *588
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -101697,9 +101249,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset
parameters:
- - *459
- - *460
- - *714
+ - *456
+ - *457
+ - *711
requestBody:
required: false
content:
@@ -101727,9 +101279,9 @@ paths:
description: Response
content:
application/json:
- schema: *713
+ schema: *710
examples:
- default: *715
+ default: *712
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -101745,9 +101297,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset
parameters:
- - *459
- - *460
- - *714
+ - *456
+ - *457
+ - *711
responses:
'204':
description: Response
@@ -101771,8 +101323,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -101857,16 +101409,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: *716
+ default: *713
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -101883,8 +101435,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: tag
description: tag parameter
in: path
@@ -101897,9 +101449,9 @@ paths:
description: Response
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: *716
+ default: *713
'404': *6
x-github:
githubCloudOnly: false
@@ -101921,9 +101473,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release
parameters:
- - *459
- - *460
- - &717
+ - *456
+ - *457
+ - &714
name: release_id
description: The unique identifier of the release.
in: path
@@ -101937,9 +101489,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: *716
+ default: *713
'401':
description: Unauthorized
x-github:
@@ -101957,9 +101509,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
requestBody:
required: false
content:
@@ -102023,9 +101575,9 @@ paths:
description: Response
content:
application/json:
- schema: *712
+ schema: *709
examples:
- default: *716
+ default: *713
'404':
description: Not Found if the discussion category name is invalid
content:
@@ -102046,9 +101598,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
responses:
'204':
description: Response
@@ -102068,9 +101620,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
- *17
- *19
responses:
@@ -102080,7 +101632,7 @@ paths:
application/json:
schema:
type: array
- items: *713
+ items: *710
examples:
default:
value:
@@ -102162,9 +101714,9 @@ paths:
description: The URL origin (protocol + host name + port) is included in `upload_url`
returned in the response of the "Create a release" endpoint
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
- name: name
in: query
required: true
@@ -102190,7 +101742,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *713
+ schema: *710
examples:
response-for-successful-upload:
value:
@@ -102245,9 +101797,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -102271,9 +101823,9 @@ paths:
application/json:
schema:
type: array
- items: *574
+ items: *571
examples:
- default: *655
+ default: *652
headers:
Link: *47
'404': *6
@@ -102294,9 +101846,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *459
- - *460
- - *717
+ - *456
+ - *457
+ - *714
requestBody:
required: true
content:
@@ -102326,16 +101878,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'201':
description: Reaction created
content:
application/json:
- schema: *574
+ schema: *571
examples:
- default: *575
+ default: *572
'422': *15
x-github:
githubCloudOnly: false
@@ -102357,10 +101909,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *459
- - *460
- - *717
- - *656
+ - *456
+ - *457
+ - *714
+ - *653
responses:
'204':
description: Response
@@ -102384,9 +101936,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch
parameters:
- - *459
- - *460
- - *512
+ - *456
+ - *457
+ - *509
- *17
- *19
responses:
@@ -102403,7 +101955,7 @@ paths:
oneOf:
- allOf:
- *170
- - &718
+ - &715
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -102424,67 +101976,67 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *171
- - *718
+ - *715
- allOf:
- *172
- - *718
+ - *715
- allOf:
- *173
- - *718
+ - *715
- allOf:
- - *719
- - *718
+ - *716
+ - *715
- allOf:
- *174
- - *718
+ - *715
- allOf:
- *175
- - *718
+ - *715
- allOf:
- *176
- - *718
+ - *715
- allOf:
- *177
- - *718
+ - *715
- allOf:
- *178
- - *718
+ - *715
- allOf:
- *179
- - *718
+ - *715
- allOf:
- *180
- - *718
+ - *715
- allOf:
- *181
- - *718
+ - *715
- allOf:
- *182
- - *718
+ - *715
- allOf:
- *183
- - *718
+ - *715
- allOf:
- *184
- - *718
+ - *715
- allOf:
- *185
- - *718
+ - *715
- allOf:
- *186
- - *718
+ - *715
- allOf:
- *187
- - *718
+ - *715
- allOf:
- *188
- - *718
+ - *715
- allOf:
- *189
- - *718
+ - *715
- allOf:
- *190
- - *718
+ - *715
examples:
default:
value:
@@ -102523,8 +102075,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
- name: includes_parents
@@ -102535,7 +102087,7 @@ paths:
schema:
type: boolean
default: true
- - *720
+ - *717
responses:
'200':
description: Response
@@ -102590,8 +102142,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
description: Request body
required: true
@@ -102620,7 +102172,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *721
+ items: *718
required:
- name
- enforcement
@@ -102653,7 +102205,7 @@ paths:
application/json:
schema: *191
examples:
- default: &730
+ default: &727
value:
id: 42
name: super cool ruleset
@@ -102700,12 +102252,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *459
- - *460
- - *722
+ - *456
+ - *457
+ - *719
- *105
- - *723
- - *724
+ - *720
+ - *721
- *17
- *19
responses:
@@ -102713,9 +102265,9 @@ paths:
description: Response
content:
application/json:
- schema: *725
+ schema: *722
examples:
- default: *726
+ default: *723
'404': *6
'500': *40
x-github:
@@ -102736,17 +102288,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *459
- - *460
- - *727
+ - *456
+ - *457
+ - *724
responses:
'200':
description: Response
content:
application/json:
- schema: *728
+ schema: *725
examples:
- default: *729
+ default: *726
'404': *6
'500': *40
x-github:
@@ -102774,8 +102326,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -102797,7 +102349,7 @@ paths:
application/json:
schema: *191
examples:
- default: *730
+ default: *727
'404': *6
'500': *40
put:
@@ -102815,8 +102367,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -102850,7 +102402,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *721
+ items: *718
examples:
default:
value:
@@ -102880,7 +102432,7 @@ paths:
application/json:
schema: *191
examples:
- default: *730
+ default: *727
'404': *6
'500': *40
delete:
@@ -102898,8 +102450,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -102922,8 +102474,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
- name: ruleset_id
@@ -102960,8 +102512,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -103034,8 +102586,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:
- - *459
- - *460
+ - *456
+ - *457
- *427
- *428
- *429
@@ -103044,8 +102596,8 @@ paths:
- *110
- *19
- *17
- - *731
- - *732
+ - *728
+ - *729
- *432
- *433
- *434
@@ -103057,7 +102609,7 @@ paths:
application/json:
schema:
type: array
- items: &736
+ items: &733
type: object
properties:
number: *128
@@ -103076,8 +102628,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *733
- resolution: *734
+ state: *730
+ resolution: *731
resolved_at:
type: string
format: date-time
@@ -103173,7 +102725,7 @@ paths:
pull request.
'
- oneOf: *735
+ oneOf: *732
nullable: true
has_more_locations:
type: boolean
@@ -103322,16 +102874,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
- *435
responses:
'200':
description: Response
content:
application/json:
- schema: *736
+ schema: *733
examples:
default:
value:
@@ -103385,9 +102937,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
requestBody:
required: true
content:
@@ -103395,8 +102947,8 @@ paths:
schema:
type: object
properties:
- state: *733
- resolution: *734
+ state: *730
+ resolution: *731
resolution_comment:
description: An optional comment when closing or reopening an alert.
Cannot be updated or deleted.
@@ -103430,7 +102982,7 @@ paths:
description: Response
content:
application/json:
- schema: *736
+ schema: *733
examples:
default:
value:
@@ -103525,9 +103077,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:
- - *459
- - *460
- - *540
+ - *456
+ - *457
+ - *537
- *19
- *17
responses:
@@ -103538,7 +103090,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &923
+ items: &918
type: object
properties:
type:
@@ -103564,6 +103116,9 @@ paths:
example: commit
details:
oneOf:
+ - *734
+ - *735
+ - *736
- *737
- *738
- *739
@@ -103574,9 +103129,6 @@ paths:
- *744
- *745
- *746
- - *747
- - *748
- - *749
examples:
default:
value:
@@ -103662,8 +103214,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -103671,14 +103223,14 @@ paths:
schema:
type: object
properties:
- reason: &751
+ reason: &748
description: The reason for bypassing push protection.
type: string
enum:
- false_positive
- used_in_tests
- will_fix_later
- placeholder_id: *750
+ placeholder_id: *747
required:
- reason
- placeholder_id
@@ -103695,7 +103247,7 @@ paths:
schema:
type: object
properties:
- reason: *751
+ reason: *748
expire_at:
type: string
format: date-time
@@ -103741,8 +103293,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'404':
description: Repository does not have GitHub Advanced Security or secret
@@ -103757,7 +103309,7 @@ paths:
properties:
incremental_scans:
type: array
- items: &752
+ items: &749
description: Information on a single scan performed by secret
scanning on the repository
type: object
@@ -103783,15 +103335,15 @@ paths:
nullable: true
pattern_update_scans:
type: array
- items: *752
+ items: *749
backfill_scans:
type: array
- items: *752
+ items: *749
custom_pattern_backfill_scans:
type: array
items:
allOf:
- - *752
+ - *749
- type: object
properties:
pattern_name:
@@ -103861,8 +103413,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *110
- name: sort
description: The property to sort the results by.
@@ -103906,9 +103458,9 @@ paths:
application/json:
schema:
type: array
- items: *753
+ items: *750
examples:
- default: *754
+ default: *751
'400': *14
'404': *6
x-github:
@@ -103931,8 +103483,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -104092,9 +103644,9 @@ paths:
description: Response
content:
application/json:
- schema: *753
+ schema: *750
examples:
- default: &756
+ default: &753
value:
ghsa_id: GHSA-abcd-1234-efgh
cve_id: CVE-2050-00000
@@ -104327,8 +103879,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -104432,7 +103984,7 @@ paths:
description: Response
content:
application/json:
- schema: *753
+ schema: *750
examples:
default:
value:
@@ -104579,17 +104131,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory
parameters:
- - *459
- - *460
- - *755
+ - *456
+ - *457
+ - *752
responses:
'200':
description: Response
content:
application/json:
- schema: *753
+ schema: *750
examples:
- default: *756
+ default: *753
'403': *29
'404': *6
x-github:
@@ -104613,9 +104165,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory
parameters:
- - *459
- - *460
- - *755
+ - *456
+ - *457
+ - *752
requestBody:
required: true
content:
@@ -104774,10 +104326,10 @@ paths:
description: Response
content:
application/json:
- schema: *753
+ schema: *750
examples:
- default: *756
- add_credit: *756
+ default: *753
+ add_credit: *753
'403': *29
'404': *6
'422':
@@ -104815,9 +104367,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- - *459
- - *460
- - *755
+ - *456
+ - *457
+ - *752
responses:
'202': *39
'400': *14
@@ -104844,17 +104396,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:
- - *459
- - *460
- - *755
+ - *456
+ - *457
+ - *752
responses:
'202':
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
+ default: *463
'400': *14
'422': *15
'403': *29
@@ -104880,8 +104432,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -104980,8 +104532,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -104990,7 +104542,7 @@ paths:
application/json:
schema:
type: array
- items: &757
+ items: &754
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -105023,8 +104575,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -105100,8 +104652,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -105197,8 +104749,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -105352,8 +104904,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -105363,7 +104915,7 @@ paths:
application/json:
schema:
type: array
- items: *757
+ items: *754
examples:
default:
value:
@@ -105396,8 +104948,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: sha
in: path
required: true
@@ -105451,7 +105003,7 @@ paths:
description: Response
content:
application/json:
- schema: *758
+ schema: *755
examples:
default:
value:
@@ -105505,8 +105057,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -105538,14 +105090,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &759
+ schema: &756
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -105613,8 +105165,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -105640,7 +105192,7 @@ paths:
description: Response
content:
application/json:
- schema: *759
+ schema: *756
examples:
default:
value:
@@ -105667,8 +105219,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -105688,8 +105240,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -105768,8 +105320,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -105777,7 +105329,7 @@ paths:
application/json:
schema:
type: array
- items: &760
+ items: &757
title: Tag protection
description: Tag protection
type: object
@@ -105829,8 +105381,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:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -105853,7 +105405,7 @@ paths:
description: Response
content:
application/json:
- schema: *760
+ schema: *757
examples:
default:
value:
@@ -105884,8 +105436,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:
- - *459
- - *460
+ - *456
+ - *457
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -105922,8 +105474,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ref
in: path
required: true
@@ -105959,8 +105511,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *17
- *19
responses:
@@ -105992,8 +105544,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics
parameters:
- - *459
- - *460
+ - *456
+ - *457
- *19
- *17
responses:
@@ -106001,7 +105553,7 @@ paths:
description: Response
content:
application/json:
- schema: &761
+ schema: &758
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -106013,7 +105565,7 @@ paths:
required:
- names
examples:
- default: &762
+ default: &759
value:
names:
- octocat
@@ -106036,8 +105588,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -106068,9 +105620,9 @@ paths:
description: Response
content:
application/json:
- schema: *761
+ schema: *758
examples:
- default: *762
+ default: *759
'404': *6
'422': *7
x-github:
@@ -106091,9 +105643,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones
parameters:
- - *459
- - *460
- - &763
+ - *456
+ - *457
+ - &760
name: per
description: The time frame to display results for.
in: query
@@ -106122,7 +105674,7 @@ paths:
example: 128
clones:
type: array
- items: &764
+ items: &761
title: Traffic
type: object
properties:
@@ -106209,8 +105761,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -106300,8 +105852,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'200':
description: Response
@@ -106361,9 +105913,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views
parameters:
- - *459
- - *460
- - *763
+ - *456
+ - *457
+ - *760
responses:
'200':
description: Response
@@ -106382,7 +105934,7 @@ paths:
example: 3782
views:
type: array
- items: *764
+ items: *761
required:
- uniques
- count
@@ -106459,8 +106011,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository
parameters:
- - *459
- - *460
+ - *456
+ - *457
requestBody:
required: true
content:
@@ -106734,8 +106286,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -106758,8 +106310,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -106781,8 +106333,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -106808,8 +106360,8 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *459
- - *460
+ - *456
+ - *457
- name: ref
in: path
required: true
@@ -106901,9 +106453,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
+ default: *463
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -107054,7 +106606,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &772
+ - &769
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -107063,7 +106615,7 @@ paths:
schema:
type: string
example: members
- - &777
+ - &774
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -107074,7 +106626,7 @@ paths:
default: 1
format: int32
example: 1
- - &778
+ - &775
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -107116,7 +106668,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &767
+ items: &764
allOf:
- type: object
required:
@@ -107191,7 +106743,7 @@ paths:
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
"$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
- meta: &779
+ meta: &776
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -107251,30 +106803,30 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &768
+ '400': &765
description: Bad request
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '401': *766
- '403': &769
+ schema: *762
+ '401': *763
+ '403': &766
description: Permission denied
- '429': &770
+ '429': &767
description: Too many requests
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '500': &771
+ schema: *762
+ '500': &768
description: Internal server error
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
+ schema: *762
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107298,7 +106850,7 @@ paths:
required: true
content:
application/json:
- schema: &775
+ schema: &772
type: object
required:
- schemas
@@ -107358,9 +106910,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *767
+ schema: *764
examples:
- group: &773
+ group: &770
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -107379,13 +106931,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
- '400': *768
- '401': *766
- '403': *769
- '409': &776
+ '400': *765
+ '401': *763
+ '403': *766
+ '409': &773
description: Duplicate record detected
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107402,7 +106954,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group
parameters:
- - &774
+ - &771
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -107410,22 +106962,22 @@ paths:
schema:
type: string
example: 7fce0092-d52e-4f76-b727-3955bd72c939
- - *772
+ - *769
- *41
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *767
+ schema: *764
examples:
- default: *773
- '400': *768
- '401': *766
- '403': *769
+ default: *770
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107444,13 +106996,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group
parameters:
- - *774
+ - *771
- *41
requestBody:
required: true
content:
application/json:
- schema: *775
+ schema: *772
examples:
group:
summary: Group
@@ -107476,17 +107028,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *767
+ schema: *764
examples:
- group: *773
- groupWithMembers: *773
- '400': *768
- '401': *766
- '403': *769
+ group: *770
+ groupWithMembers: *770
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '409': *776
- '429': *770
- '500': *771
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107510,13 +107062,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
parameters:
- - *774
+ - *771
- *41
requestBody:
required: true
content:
application/json:
- schema: &786
+ schema: &783
type: object
required:
- Operations
@@ -107576,17 +107128,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *767
+ schema: *764
examples:
- updateGroup: *773
- addMembers: *773
- '400': *768
- '401': *766
- '403': *769
+ updateGroup: *770
+ addMembers: *770
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '409': *776
- '429': *770
- '500': *771
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107602,17 +107154,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise
parameters:
- - *774
+ - *771
- *41
responses:
'204':
description: Group was deleted, no content
- '400': *768
- '401': *766
- '403': *769
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107646,8 +107198,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *777
- - *778
+ - *774
+ - *775
- *41
responses:
'200':
@@ -107680,7 +107232,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &781
+ items: &778
allOf:
- type: object
required:
@@ -107759,7 +107311,7 @@ paths:
description: Whether this email address is the primary
address.
example: true
- roles: &780
+ roles: &777
type: array
description: The roles assigned to the user.
items:
@@ -107815,7 +107367,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *779
+ meta: *776
startIndex:
type: integer
description: A starting index for the returned page
@@ -107852,11 +107404,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *768
- '401': *766
- '403': *769
- '429': *770
- '500': *771
+ '400': *765
+ '401': *763
+ '403': *766
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -107880,7 +107432,7 @@ paths:
required: true
content:
application/json:
- schema: &784
+ schema: &781
type: object
required:
- schemas
@@ -107962,9 +107514,9 @@ paths:
type: boolean
description: Whether this email address is the primary address.
example: true
- roles: *780
+ roles: *777
examples:
- user: &785
+ user: &782
summary: User
value:
schemas:
@@ -108011,9 +107563,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *781
+ schema: *778
examples:
- user: &782
+ user: &779
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -108039,13 +107591,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939
- enterpriseOwner: *782
- '400': *768
- '401': *766
- '403': *769
- '409': *776
- '429': *770
- '500': *771
+ enterpriseOwner: *779
+ '400': *765
+ '401': *763
+ '403': *766
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108062,7 +107614,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user
parameters:
- - &783
+ - &780
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -108075,15 +107627,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *781
+ schema: *778
examples:
- default: *782
- '400': *768
- '401': *766
- '403': *769
+ default: *779
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108105,30 +107657,30 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user
parameters:
- - *783
+ - *780
- *41
requestBody:
required: true
content:
application/json:
- schema: *784
+ schema: *781
examples:
- user: *785
+ user: *782
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *781
+ schema: *778
examples:
- user: *782
- '400': *768
- '401': *766
- '403': *769
+ user: *779
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '409': *776
- '429': *770
- '500': *771
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108163,13 +107715,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
parameters:
- - *783
+ - *780
- *41
requestBody:
required: true
content:
application/json:
- schema: *786
+ schema: *783
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -108209,18 +107761,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *781
+ schema: *778
examples:
- userMultiValuedProperties: *782
- userSingleValuedProperties: *782
- disableUser: *782
- '400': *768
- '401': *766
- '403': *769
+ userMultiValuedProperties: *779
+ userSingleValuedProperties: *779
+ disableUser: *779
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '409': *776
- '429': *770
- '500': *771
+ '409': *773
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108240,17 +107792,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise
parameters:
- - *783
+ - *780
- *41
responses:
'204':
description: User was deleted, no content
- '400': *768
- '401': *766
- '403': *769
+ '400': *765
+ '401': *763
+ '403': *766
'404': *6
- '429': *770
- '500': *771
+ '429': *767
+ '500': *768
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -108337,7 +107889,7 @@ paths:
example: 1
Resources:
type: array
- items: &787
+ items: &784
title: SCIM /Users
description: SCIM /Users provisioning endpoints
type: object
@@ -108568,22 +108120,22 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243
'304': *37
- '404': &788
+ '404': &785
description: Resource not found
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '403': &789
+ schema: *762
+ '403': &786
description: Forbidden
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '400': *768
- '429': *770
+ schema: *762
+ '400': *765
+ '429': *767
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -108609,9 +108161,9 @@ paths:
description: Response
content:
application/scim+json:
- schema: *787
+ schema: *784
examples:
- default: &790
+ default: &787
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -108634,17 +108186,17 @@ paths:
lastModified: '2017-03-09T16:11:13-05:00'
location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32
'304': *37
- '404': *788
- '403': *789
- '500': *771
+ '404': *785
+ '403': *786
+ '500': *768
'409':
description: Conflict
content:
application/json:
- schema: *765
+ schema: *762
application/scim+json:
- schema: *765
- '400': *768
+ schema: *762
+ '400': *765
requestBody:
required: true
content:
@@ -108742,17 +108294,17 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user
parameters:
- *87
- - *783
+ - *780
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *787
+ schema: *784
examples:
- default: *790
- '404': *788
- '403': *789
+ default: *787
+ '404': *785
+ '403': *786
'304': *37
x-github:
githubCloudOnly: true
@@ -108776,18 +108328,18 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership
parameters:
- *87
- - *783
+ - *780
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *787
+ schema: *784
examples:
- default: *790
+ default: *787
'304': *37
- '404': *788
- '403': *789
+ '404': *785
+ '403': *786
requestBody:
required: true
content:
@@ -108900,19 +108452,19 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user
parameters:
- *87
- - *783
+ - *780
responses:
'200':
description: Response
content:
application/scim+json:
- schema: *787
+ schema: *784
examples:
- default: *790
+ default: *787
'304': *37
- '404': *788
- '403': *789
- '400': *768
+ '404': *785
+ '403': *786
+ '400': *765
'429':
description: Response
content:
@@ -109003,12 +108555,12 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization
parameters:
- *87
- - *783
+ - *780
responses:
'204':
description: Response
- '404': *788
- '403': *789
+ '404': *785
+ '403': *786
'304': *37
x-github:
githubCloudOnly: true
@@ -109141,7 +108693,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &791
+ text_matches: &788
title: Search Result Text Matches
type: array
items:
@@ -109304,7 +108856,7 @@ paths:
enum:
- author-date
- committer-date
- - &792
+ - &789
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
@@ -109375,7 +108927,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *510
+ properties: *507
nullable: true
comment_count:
type: integer
@@ -109395,7 +108947,7 @@ paths:
url:
type: string
format: uri
- verification: *638
+ verification: *635
required:
- author
- committer
@@ -109414,7 +108966,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *510
+ properties: *507
nullable: true
parents:
type: array
@@ -109432,7 +108984,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *791
+ text_matches: *788
required:
- sha
- node_id
@@ -109625,7 +109177,7 @@ paths:
- interactions
- created
- updated
- - *792
+ - *789
- *17
- *19
- name: advanced_search
@@ -109722,11 +109274,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
type: string
state_reason:
@@ -109758,7 +109310,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *791
+ text_matches: *788
pull_request:
type: object
properties:
@@ -109983,7 +109535,7 @@ paths:
enum:
- created
- updated
- - *792
+ - *789
- *17
- *19
responses:
@@ -110027,7 +109579,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *791
+ text_matches: *788
required:
- id
- node_id
@@ -110113,7 +109665,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *792
+ - *789
- *17
- *19
responses:
@@ -110352,7 +109904,7 @@ paths:
- admin
- pull
- push
- text_matches: *791
+ text_matches: *788
temp_clone_token:
type: string
allow_merge_commit:
@@ -110653,7 +110205,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *791
+ text_matches: *788
related:
type: array
nullable: true
@@ -110846,7 +110398,7 @@ paths:
- followers
- repositories
- joined
- - *792
+ - *789
- *17
- *19
responses:
@@ -110950,7 +110502,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *791
+ text_matches: *788
blog:
type: string
nullable: true
@@ -111029,7 +110581,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy
parameters:
- - &796
+ - &793
name: team_id
description: The unique identifier of the team.
in: path
@@ -111070,7 +110622,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy
parameters:
- - *796
+ - *793
requestBody:
required: true
content:
@@ -111170,7 +110722,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy
parameters:
- - *796
+ - *793
responses:
'204':
description: Response
@@ -111184,226 +110736,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy
- parameters:
- - *796
- - *110
- - *17
- - *19
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *451
- examples:
- default: *797
- headers:
- Link: *47
- 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]
- > **Endpoint closing down notice:** 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.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - *796
- 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: *451
- examples:
- default: *452
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - *796
- - *453
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *451
- examples:
- default: *452
- 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]
- > **Endpoint closing down notice:** 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.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth 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:
- - *796
- - *453
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *451
- examples:
- default: *798
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - *796
- - *453
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -111419,7 +110751,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy
parameters:
- - *796
+ - *793
- *17
- *19
responses:
@@ -111457,7 +110789,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy
parameters:
- - *796
+ - *793
- name: role
description: Filters members returned by their role in the team.
in: query
@@ -111508,7 +110840,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'204':
@@ -111545,7 +110877,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'204':
@@ -111585,7 +110917,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'204':
@@ -111622,16 +110954,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'200':
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- response-if-user-is-a-team-maintainer: *799
+ response-if-user-is-a-team-maintainer: *794
'404': *6
x-github:
githubCloudOnly: false
@@ -111664,7 +110996,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- - *796
+ - *793
- *143
requestBody:
required: false
@@ -111690,9 +111022,9 @@ paths:
description: Response
content:
application/json:
- schema: *458
+ schema: *455
examples:
- response-if-users-membership-with-team-is-now-pending: *800
+ response-if-users-membership-with-team-is-now-pending: *795
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -111726,7 +111058,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy
parameters:
- - *796
+ - *793
- *143
responses:
'204':
@@ -111754,7 +111086,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy
parameters:
- - *796
+ - *793
- *17
- *19
responses:
@@ -111796,15 +111128,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- - *796
- - *459
- - *460
+ - *793
+ - *456
+ - *457
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *801
+ schema: *796
examples:
alternative-response-with-extra-repository-information:
value:
@@ -111955,9 +111287,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- - *796
- - *459
- - *460
+ - *793
+ - *456
+ - *457
requestBody:
required: false
content:
@@ -112007,9 +111339,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- - *796
- - *459
- - *460
+ - *793
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -112038,15 +111370,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy
parameters:
- - *796
+ - *793
responses:
'200':
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
- default: *462
+ default: *459
'403': *29
'404': *6
x-github:
@@ -112073,7 +111405,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy
parameters:
- - *796
+ - *793
requestBody:
required: true
content:
@@ -112130,7 +111462,7 @@ paths:
description: Response
content:
application/json:
- schema: *461
+ schema: *458
examples:
default:
value:
@@ -112161,7 +111493,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy
parameters:
- - *796
+ - *793
- *17
- *19
responses:
@@ -112173,7 +111505,7 @@ paths:
type: array
items: *313
examples:
- response-if-child-teams-exist: *802
+ response-if-child-teams-exist: *797
headers:
Link: *47
'404': *6
@@ -112206,7 +111538,7 @@ paths:
application/json:
schema:
oneOf:
- - &804
+ - &799
title: Private User
description: Private User
type: object
@@ -112409,7 +111741,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *803
+ - *798
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -112562,7 +111894,7 @@ paths:
description: Response
content:
application/json:
- schema: *804
+ schema: *799
examples:
default:
value:
@@ -112908,7 +112240,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'202':
description: Response when the codespace creation partially failed but is
being retried in the background
@@ -112916,7 +112248,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'401': *25
'403': *29
'404': *6
@@ -112960,7 +112292,7 @@ paths:
type: integer
secrets:
type: array
- items: &805
+ items: &800
title: Codespaces Secret
description: Secrets for a GitHub Codespace.
type: object
@@ -113000,7 +112332,7 @@ paths:
- visibility
- selected_repositories_url
examples:
- default: *566
+ default: *563
headers:
Link: *47
x-github:
@@ -113076,7 +112408,7 @@ paths:
description: Response
content:
application/json:
- schema: *805
+ schema: *800
examples:
default:
value:
@@ -113222,7 +112554,7 @@ paths:
type: array
items: *284
examples:
- default: *806
+ default: *801
'401': *25
'403': *29
'404': *6
@@ -113374,7 +112706,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'304': *37
'500': *40
'401': *25
@@ -113432,7 +112764,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'401': *25
'403': *29
'404': *6
@@ -113489,7 +112821,7 @@ paths:
description: Response
content:
application/json:
- schema: &807
+ schema: &802
type: object
title: Fetches information about an export of a codespace.
description: An export of a codespace. Also, latest export details
@@ -113530,7 +112862,7 @@ paths:
description: Web url for the exported branch
example: https://github.com/octocat/hello-world/tree/:branch
examples:
- default: &808
+ default: &803
value:
state: succeeded
completed_at: '2022-01-01T14:59:22Z'
@@ -113575,9 +112907,9 @@ paths:
description: Response
content:
application/json:
- schema: *807
+ schema: *802
examples:
- default: *808
+ default: *803
'404': *6
x-github:
githubCloudOnly: false
@@ -113614,9 +112946,9 @@ paths:
type: integer
machines:
type: array
- items: *809
+ items: *804
examples:
- default: *810
+ default: *805
'304': *37
'500': *40
'401': *25
@@ -113695,13 +113027,13 @@ paths:
nullable: true
owner: *4
billable_owner: *4
- repository: *464
+ repository: *461
machine:
type: object
title: Codespace machine
description: A description of the machine powering a codespace.
- properties: *564
- required: *565
+ properties: *561
+ required: *562
nullable: true
devcontainer_path:
description: Path to devcontainer.json from repo root used to
@@ -114483,7 +113815,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'304': *37
'500': *40
'400': *14
@@ -114523,7 +113855,7 @@ paths:
application/json:
schema: *376
examples:
- default: *563
+ default: *560
'500': *40
'401': *25
'403': *29
@@ -114555,7 +113887,7 @@ paths:
type: array
items: *387
examples:
- default: &821
+ default: &816
value:
- id: 197
name: hello_docker
@@ -114656,7 +113988,7 @@ paths:
application/json:
schema:
type: array
- items: &811
+ items: &806
title: Email
description: Email
type: object
@@ -114721,9 +114053,9 @@ paths:
application/json:
schema:
type: array
- items: *811
+ items: *806
examples:
- default: &823
+ default: &818
value:
- email: octocat@github.com
verified: true
@@ -114798,7 +114130,7 @@ paths:
application/json:
schema:
type: array
- items: *811
+ items: *806
examples:
default:
value:
@@ -115054,7 +114386,7 @@ paths:
application/json:
schema:
type: array
- items: &812
+ items: &807
title: GPG Key
description: A unique encryption key
type: object
@@ -115185,7 +114517,7 @@ paths:
- subkeys
- revoked
examples:
- default: &837
+ default: &832
value:
- id: 3
name: Octocat's GPG Key
@@ -115270,9 +114602,9 @@ paths:
description: Response
content:
application/json:
- schema: *812
+ schema: *807
examples:
- default: &813
+ default: &808
value:
id: 3
name: Octocat's GPG Key
@@ -115329,7 +114661,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &814
+ - &809
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -115341,9 +114673,9 @@ paths:
description: Response
content:
application/json:
- schema: *812
+ schema: *807
examples:
- default: *813
+ default: *808
'404': *6
'304': *37
'403': *29
@@ -115366,7 +114698,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *814
+ - *809
responses:
'204':
description: Response
@@ -115671,7 +115003,7 @@ paths:
required: true
content:
application/json:
- schema: *649
+ schema: *646
examples:
default:
value:
@@ -115821,7 +115153,7 @@ paths:
application/json:
schema:
type: array
- items: &815
+ items: &810
title: Key
description: Key
type: object
@@ -115922,9 +115254,9 @@ paths:
description: Response
content:
application/json:
- schema: *815
+ schema: *810
examples:
- default: &816
+ default: &811
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -115957,15 +115289,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *680
+ - *677
responses:
'200':
description: Response
content:
application/json:
- schema: *815
+ schema: *810
examples:
- default: *816
+ default: *811
'404': *6
'304': *37
'403': *29
@@ -115988,7 +115320,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *680
+ - *677
responses:
'204':
description: Response
@@ -116021,7 +115353,7 @@ paths:
application/json:
schema:
type: array
- items: &817
+ items: &812
title: User Marketplace Purchase
description: User Marketplace Purchase
type: object
@@ -116089,7 +115421,7 @@ paths:
- account
- plan
examples:
- default: &818
+ default: &813
value:
- billing_cycle: monthly
next_billing_date: '2017-11-11T00:00:00Z'
@@ -116151,9 +115483,9 @@ paths:
application/json:
schema:
type: array
- items: *817
+ items: *812
examples:
- default: *818
+ default: *813
headers:
Link: *47
'304': *37
@@ -117162,7 +116494,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository
parameters:
- *382
- - *819
+ - *814
responses:
'204':
description: Response
@@ -117277,7 +116609,7 @@ paths:
- docker
- nuget
- container
- - *820
+ - *815
- *19
- *17
responses:
@@ -117289,8 +116621,8 @@ paths:
type: array
items: *387
examples:
- default: *821
- '400': *822
+ default: *816
+ '400': *817
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -117319,7 +116651,7 @@ paths:
application/json:
schema: *387
examples:
- default: &838
+ default: &833
value:
id: 40201
name: octo-name
@@ -117681,9 +117013,9 @@ paths:
application/json:
schema:
type: array
- items: *811
+ items: *806
examples:
- default: *823
+ default: *818
headers:
Link: *47
'304': *37
@@ -117796,7 +117128,7 @@ paths:
type: array
items: *78
examples:
- default: &830
+ default: &825
summary: Default response
value:
- id: 1296269
@@ -118100,9 +117432,9 @@ paths:
description: Response
content:
application/json:
- schema: *464
+ schema: *461
examples:
- default: *466
+ default: *463
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -118140,9 +117472,9 @@ paths:
application/json:
schema:
type: array
- items: *651
+ items: *648
examples:
- default: *824
+ default: *819
headers:
Link: *47
'304': *37
@@ -118221,7 +117553,7 @@ paths:
application/json:
schema:
type: array
- items: &825
+ items: &820
title: Social account
description: Social media account
type: object
@@ -118236,7 +117568,7 @@ paths:
- provider
- url
examples:
- default: &826
+ default: &821
value:
- provider: twitter
url: https://twitter.com/github
@@ -118298,9 +117630,9 @@ paths:
application/json:
schema:
type: array
- items: *825
+ items: *820
examples:
- default: *826
+ default: *821
'422': *15
'304': *37
'404': *6
@@ -118387,7 +117719,7 @@ paths:
application/json:
schema:
type: array
- items: &827
+ items: &822
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -118407,7 +117739,7 @@ paths:
- title
- created_at
examples:
- default: &852
+ default: &847
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -118471,9 +117803,9 @@ paths:
description: Response
content:
application/json:
- schema: *827
+ schema: *822
examples:
- default: &828
+ default: &823
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -118503,7 +117835,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &829
+ - &824
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -118515,9 +117847,9 @@ paths:
description: Response
content:
application/json:
- schema: *827
+ schema: *822
examples:
- default: *828
+ default: *823
'404': *6
'304': *37
'403': *29
@@ -118540,7 +117872,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *829
+ - *824
responses:
'204':
description: Response
@@ -118569,7 +117901,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &853
+ - &848
name: sort
description: The property to sort the results by. `created` means when the
repository was starred. `updated` means when the repository was last pushed
@@ -118594,11 +117926,11 @@ paths:
type: array
items: *78
examples:
- default-response: *830
+ default-response: *825
application/vnd.github.v3.star+json:
schema:
type: array
- items: &854
+ items: &849
title: Starred Repository
description: Starred Repository
type: object
@@ -118754,8 +118086,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response if this repository is starred by you
@@ -118783,8 +118115,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -118808,8 +118140,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:
- - *459
- - *460
+ - *456
+ - *457
responses:
'204':
description: Response
@@ -118967,10 +118299,10 @@ paths:
application/json:
schema:
oneOf:
- - *804
- - *803
+ - *799
+ - *798
examples:
- default-response: &832
+ default-response: &827
summary: Default response
value:
login: octocat
@@ -119005,7 +118337,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &833
+ response-with-git-hub-plan-information: &828
summary: Response with GitHub plan information
value:
login: octocat
@@ -119127,7 +118459,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users
parameters:
- - *831
+ - *826
- *17
responses:
'200':
@@ -119176,11 +118508,11 @@ paths:
application/json:
schema:
oneOf:
- - *804
- - *803
+ - *799
+ - *798
examples:
- default-response: *832
- response-with-git-hub-plan-information: *833
+ default-response: *827
+ response-with-git-hub-plan-information: *828
'404': *6
x-github:
githubCloudOnly: false
@@ -119230,8 +118562,8 @@ paths:
required:
- subject_digests
examples:
- default: *834
- withPredicateType: *835
+ default: *829
+ withPredicateType: *830
responses:
'200':
description: Response
@@ -119284,7 +118616,7 @@ paths:
description: The cursor to the previous page.
description: Information about the current page.
examples:
- default: *836
+ default: *831
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -119489,7 +118821,7 @@ paths:
initiator:
type: string
examples:
- default: *506
+ default: *503
'201':
description: Response
content:
@@ -119530,7 +118862,7 @@ paths:
type: array
items: *387
examples:
- default: *821
+ default: *816
'403': *29
'401': *25
x-github:
@@ -119914,9 +119246,9 @@ paths:
application/json:
schema:
type: array
- items: *812
+ items: *807
examples:
- default: *837
+ default: *832
headers:
Link: *47
x-github:
@@ -120020,7 +119352,7 @@ paths:
application/json:
schema: *22
examples:
- default: *648
+ default: *645
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120144,7 +119476,7 @@ paths:
- docker
- nuget
- container
- - *820
+ - *815
- *143
- *19
- *17
@@ -120157,10 +119489,10 @@ paths:
type: array
items: *387
examples:
- default: *821
+ default: *816
'403': *29
'401': *25
- '400': *822
+ '400': *817
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120190,7 +119522,7 @@ paths:
application/json:
schema: *387
examples:
- default: *838
+ default: *833
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -120539,7 +119871,7 @@ paths:
type: array
items: *409
examples:
- default: *839
+ default: *834
headers:
Link: *47
'304': *37
@@ -120599,7 +119931,7 @@ paths:
description: The options available for single select fields. At
least one option must be provided when creating a single select
field.
- items: *840
+ items: *835
required:
- name
- data_type
@@ -120615,7 +119947,7 @@ paths:
description: The field's data type.
enum:
- iteration
- iteration_configuration: *841
+ iteration_configuration: *836
required:
- name
- data_type
@@ -120637,8 +119969,8 @@ paths:
value:
name: Due date
data_type: date
- single_select_field: *842
- iteration_field: *843
+ single_select_field: *837
+ iteration_field: *838
responses:
'201':
description: Response
@@ -120646,11 +119978,11 @@ paths:
application/json:
schema: *409
examples:
- text_field: *844
- number_field: *845
- date_field: *846
- single_select_field: *847
- iteration_field: *848
+ text_field: *839
+ number_field: *840
+ date_field: *841
+ single_select_field: *842
+ iteration_field: *843
'304': *37
'403': *29
'401': *25
@@ -120672,7 +120004,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user
parameters:
- *405
- - *849
+ - *844
- *143
responses:
'200':
@@ -120681,7 +120013,7 @@ paths:
application/json:
schema: *409
examples:
- default: *850
+ default: *845
headers:
Link: *47
'304': *37
@@ -121035,7 +120367,7 @@ paths:
parameters:
- *405
- *143
- - *851
+ - *846
- name: fields
description: |-
Limit results to specific fields, by their IDs. If not specified, the
@@ -121314,9 +120646,9 @@ paths:
application/json:
schema:
type: array
- items: *825
+ items: *820
examples:
- default: *826
+ default: *821
headers:
Link: *47
x-github:
@@ -121346,9 +120678,9 @@ paths:
application/json:
schema:
type: array
- items: *827
+ items: *822
examples:
- default: *852
+ default: *847
headers:
Link: *47
x-github:
@@ -121373,7 +120705,7 @@ paths:
url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *143
- - *853
+ - *848
- *110
- *17
- *19
@@ -121385,11 +120717,11 @@ paths:
schema:
anyOf:
- type: array
- items: *854
+ items: *849
- type: array
items: *78
examples:
- default-response: *830
+ default-response: *825
headers:
Link: *47
x-github:
@@ -121548,7 +120880,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &855
+ enterprise: &850
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -121606,7 +120938,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &856
+ installation: &851
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -121625,7 +120957,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &857
+ organization: &852
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -121685,13 +121017,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &858
+ repository: &853
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: &895
+ properties: &890
id:
description: Unique identifier of the repository
example: 42
@@ -122374,7 +121706,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &896
+ required: &891
- archive_url
- assignees_url
- blobs_url
@@ -122525,10 +121857,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -122604,11 +121936,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- rule: &859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ rule: &854
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -122831,11 +122163,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- rule: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ rule: *854
sender: *4
required:
- action
@@ -123018,11 +122350,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- rule: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ rule: *854
sender: *4
required:
- action
@@ -123095,7 +122427,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &879
+ schema: &874
title: Exemption request cancellation event
type: object
properties:
@@ -123103,11 +122435,11 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: &860
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: &855
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -123376,7 +122708,7 @@ x-webhooks:
type: array
description: The responses to the exemption request.
nullable: true
- items: &861
+ items: &856
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -123486,7 +122818,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &880
+ schema: &875
title: Exemption request completed event
type: object
properties:
@@ -123494,11 +122826,11 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: *860
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: *855
sender: *4
required:
- action
@@ -123570,7 +122902,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &877
+ schema: &872
title: Exemption request created event
type: object
properties:
@@ -123578,11 +122910,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: *860
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: *855
sender: *4
required:
- action
@@ -123654,7 +122986,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &881
+ schema: &876
title: Exemption response dismissed event
type: object
properties:
@@ -123662,12 +122994,12 @@ x-webhooks:
type: string
enum:
- response_dismissed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: *860
- exemption_response: *861
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: *855
+ exemption_response: *856
sender: *4
required:
- action
@@ -123741,7 +123073,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: &878
+ schema: &873
title: Exemption response submitted event
type: object
properties:
@@ -123749,12 +123081,12 @@ x-webhooks:
type: string
enum:
- response_submitted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- exemption_request: *860
- exemption_response: *861
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ exemption_request: *855
+ exemption_response: *856
sender: *4
required:
- action
@@ -123838,7 +123170,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &863
+ check_run: &858
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -123929,7 +123261,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *862
+ deployment: *857
details_url:
example: https://example.com
type: string
@@ -124014,10 +123346,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *856
- enterprise: *855
- organization: *857
- repository: *858
+ installation: *851
+ enterprise: *850
+ organization: *852
+ repository: *853
sender: *4
required:
- check_run
@@ -124410,11 +123742,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *863
- installation: *856
- enterprise: *855
- organization: *857
- repository: *858
+ check_run: *858
+ installation: *851
+ enterprise: *850
+ organization: *852
+ repository: *853
sender: *4
required:
- check_run
@@ -124810,11 +124142,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *863
- installation: *856
- enterprise: *855
- organization: *857
- repository: *858
+ check_run: *858
+ installation: *851
+ enterprise: *850
+ organization: *852
+ repository: *853
requested_action:
description: The action requested by the user.
type: object
@@ -125219,11 +124551,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *863
- installation: *856
- enterprise: *855
- organization: *857
- repository: *858
+ check_run: *858
+ installation: *851
+ enterprise: *850
+ organization: *852
+ repository: *853
sender: *4
required:
- check_run
@@ -126200,10 +125532,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -126897,10 +126229,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -127588,10 +126920,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -127757,7 +127089,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -127902,20 +127234,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &864
+ commit_oid: &859
description: The commit SHA of the code scanning alert. When the
action is `reopened_by_user` or `closed_by_user`, the event was
triggered by the `sender` and this value will be empty.
type: string
- enterprise: *855
- installation: *856
- organization: *857
- ref: &865
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: &860
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -128080,7 +127412,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -128310,12 +127642,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *864
- enterprise: *855
- installation: *856
- organization: *857
- ref: *865
- repository: *858
+ commit_oid: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: *860
+ repository: *853
sender: *4
required:
- action
@@ -128410,7 +127742,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -128581,12 +127913,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *864
- enterprise: *855
- installation: *856
- organization: *857
- ref: *865
- repository: *858
+ commit_oid: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: *860
+ repository: *853
sender: *4
required:
- action
@@ -128752,7 +128084,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -128918,12 +128250,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *864
- enterprise: *855
- installation: *856
- organization: *857
- ref: *865
- repository: *858
+ commit_oid: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: *860
+ repository: *853
sender: *4
required:
- action
@@ -129022,7 +128354,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -129197,16 +128529,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
nullable: true
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -129303,7 +128635,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -129443,12 +128775,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *864
- enterprise: *855
- installation: *856
- organization: *857
- ref: *865
- repository: *858
+ commit_oid: *859
+ enterprise: *850
+ installation: *851
+ organization: *852
+ ref: *860
+ repository: *853
sender: *4
required:
- action
@@ -129614,7 +128946,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *535
+ dismissed_comment: *532
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -129759,10 +129091,10 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -130017,10 +129349,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -130100,18 +129432,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *857
- pusher_type: &866
+ organization: *852
+ pusher_type: &861
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &867
+ ref: &862
description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference)
resource.
type: string
@@ -130121,7 +129453,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *858
+ repository: *853
sender: *4
required:
- ref
@@ -130204,9 +129536,9 @@ x-webhooks:
enum:
- created
definition: *157
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -130291,9 +129623,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -130371,9 +129703,9 @@ x-webhooks:
enum:
- promote_to_enterprise
definition: *157
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -130451,9 +129783,9 @@ x-webhooks:
enum:
- updated
definition: *157
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -130530,10 +129862,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- repository: *858
- organization: *857
+ enterprise: *850
+ installation: *851
+ repository: *853
+ organization: *852
sender: *4
new_property_values:
type: array
@@ -130618,18 +129950,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
- pusher_type: *866
- ref: *867
+ enterprise: *850
+ installation: *851
+ organization: *852
+ pusher_type: *861
+ ref: *862
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *858
+ repository: *853
sender: *4
required:
- ref
@@ -130713,11 +130045,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -130801,11 +130133,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -130889,11 +130221,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -130975,11 +130307,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -131061,11 +130393,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -131148,11 +130480,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -131234,11 +130566,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *597
- installation: *856
- organization: *857
- enterprise: *855
- repository: *858
+ alert: *594
+ installation: *851
+ organization: *852
+ enterprise: *850
+ repository: *853
sender: *4
required:
- action
@@ -131315,9 +130647,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- key: &868
+ enterprise: *850
+ installation: *851
+ key: &863
description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -131353,8 +130685,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -131431,11 +130763,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- key: *868
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ key: *863
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -131996,12 +131328,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: &872
+ workflow: &867
title: Workflow
type: object
nullable: true
@@ -132727,13 +132059,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *603
+ deployment: *600
pull_requests:
type: array
- items: *701
- repository: *858
- organization: *857
- installation: *856
+ items: *698
+ repository: *853
+ organization: *852
+ installation: *851
sender: *4
responses:
'200':
@@ -132804,7 +132136,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &869
+ approver: &864
type: object
properties:
avatar_url:
@@ -132847,11 +132179,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- reviewers: &870
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ reviewers: &865
type: array
items:
type: object
@@ -132930,7 +132262,7 @@ x-webhooks:
sender: *4
since:
type: string
- workflow_job_run: &871
+ workflow_job_run: &866
type: object
properties:
conclusion:
@@ -133661,18 +132993,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *869
+ approver: *864
comment:
type: string
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- reviewers: *870
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ reviewers: *865
sender: *4
since:
type: string
- workflow_job_run: *871
+ workflow_job_run: *866
workflow_job_runs:
type: array
items:
@@ -134376,13 +133708,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *855
+ enterprise: *850
environment:
type: string
- installation: *856
- organization: *857
- repository: *858
- requestor: &882
+ installation: *851
+ organization: *852
+ repository: *853
+ requestor: &877
title: User
type: object
nullable: true
@@ -136281,12 +135613,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: *872
+ workflow: *867
workflow_run:
title: Deployment Workflow Run
type: object
@@ -136966,7 +136298,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &875
+ answer: &870
type: object
properties:
author_association:
@@ -137123,11 +136455,11 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137254,11 +136586,11 @@ x-webhooks:
- from
required:
- category
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137341,11 +136673,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137427,7 +136759,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &874
+ comment: &869
type: object
properties:
author_association:
@@ -137584,11 +136916,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137671,12 +137003,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *874
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ comment: *869
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137771,12 +137103,12 @@ x-webhooks:
- from
required:
- body
- comment: *874
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ comment: *869
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137860,11 +137192,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -137946,11 +137278,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138050,11 +137382,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138136,10 +137468,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *873
- enterprise: *855
- installation: *856
- label: &876
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ label: &871
title: Label
type: object
properties:
@@ -138171,8 +137503,8 @@ x-webhooks:
- color
- default
- description
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138255,11 +137587,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138341,11 +137673,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138427,11 +137759,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138516,16 +137848,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *873
- new_repository: *858
+ new_discussion: *868
+ new_repository: *853
required:
- new_discussion
- new_repository
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138608,10 +137940,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *873
- old_answer: *875
- organization: *857
- repository: *858
+ discussion: *868
+ old_answer: *870
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138693,12 +138025,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *873
- enterprise: *855
- installation: *856
- label: *876
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138781,11 +138113,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138867,11 +138199,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *873
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ discussion: *868
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -138940,7 +138272,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *877
+ schema: *872
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139003,7 +138335,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *878
+ schema: *873
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139066,7 +138398,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *879
+ schema: *874
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139129,7 +138461,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *877
+ schema: *872
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139192,7 +138524,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *878
+ schema: *873
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139258,7 +138590,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *879
+ schema: *874
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139324,7 +138656,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *880
+ schema: *875
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139390,7 +138722,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *877
+ schema: *872
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139456,7 +138788,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *881
+ schema: *876
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139522,7 +138854,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *878
+ schema: *873
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139587,7 +138919,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *879
+ schema: *874
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139652,7 +138984,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *880
+ schema: *875
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139717,7 +139049,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *877
+ schema: *872
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139782,7 +139114,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *881
+ schema: *876
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139848,7 +139180,7 @@ x-webhooks:
required: true
content:
application/json:
- schema: *878
+ schema: *873
responses:
'200':
description: Return a 200 status to indicate that the data was received
@@ -139915,7 +139247,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *855
+ enterprise: *850
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository)
resource.
@@ -140575,9 +139907,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- forkee
@@ -140723,9 +140055,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pages:
description: The pages that were updated.
type: array
@@ -140762,7 +140094,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *858
+ repository: *853
sender: *4
required:
- pages
@@ -140838,10 +140170,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: &883
+ organization: *852
+ repositories: &878
description: An array of repository objects that the installation
can access.
type: array
@@ -140867,8 +140199,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *858
- requester: *882
+ repository: *853
+ requester: *877
sender: *4
required:
- action
@@ -140943,11 +140275,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: *883
- repository: *858
+ organization: *852
+ repositories: *878
+ repository: *853
requester:
nullable: true
sender: *4
@@ -141023,11 +140355,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: *883
- repository: *858
+ organization: *852
+ repositories: *878
+ repository: *853
requester:
nullable: true
sender: *4
@@ -141103,10 +140435,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories_added: &884
+ organization: *852
+ repositories_added: &879
description: An array of repository objects, which were added to
the installation.
type: array
@@ -141152,15 +140484,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *858
- repository_selection: &885
+ repository: *853
+ repository_selection: &880
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *882
+ requester: *877
sender: *4
required:
- action
@@ -141239,10 +140571,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories_added: *884
+ organization: *852
+ repositories_added: *879
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -141269,9 +140601,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *858
- repository_selection: *885
- requester: *882
+ repository: *853
+ repository_selection: *880
+ requester: *877
sender: *4
required:
- action
@@ -141350,11 +140682,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: *883
- repository: *858
+ organization: *852
+ repositories: *878
+ repository: *853
requester:
nullable: true
sender: *4
@@ -141533,10 +140865,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
target_type:
type: string
@@ -141615,11 +140947,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *855
+ enterprise: *850
installation: *22
- organization: *857
- repositories: *883
- repository: *858
+ organization: *852
+ repositories: *878
+ repository: *853
requester:
nullable: true
sender: *4
@@ -141871,8 +141203,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -142666,8 +141998,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -143016,8 +142348,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -143097,7 +142429,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &886
+ comment: &881
title: issue comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment)
itself.
@@ -143262,8 +142594,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -144053,8 +143385,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -144405,8 +143737,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -144486,7 +143818,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &915
+ changes: &910
description: The changes to the comment.
type: object
properties:
@@ -144498,9 +143830,9 @@ x-webhooks:
type: string
required:
- from
- comment: *886
- enterprise: *855
- installation: *856
+ comment: *881
+ enterprise: *850
+ installation: *851
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -145293,8 +144625,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -145643,8 +144975,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -145734,9 +145066,9 @@ x-webhooks:
type: number
blocking_issue: *221
blocking_issue_repo: *78
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -145825,9 +145157,9 @@ x-webhooks:
type: number
blocking_issue: *221
blocking_issue_repo: *78
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -145915,9 +145247,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -146006,9 +145338,9 @@ x-webhooks:
description: The ID of the blocking issue.
type: number
blocking_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -146088,10 +145420,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *882
- enterprise: *855
- installation: *856
- issue: &889
+ assignee: *877
+ enterprise: *850
+ installation: *851
+ issue: &884
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -146880,11 +146212,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -147001,8 +146333,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -147082,8 +146414,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -147877,11 +147209,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -148133,8 +147465,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -148213,8 +147545,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -148999,11 +148331,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -149119,8 +148451,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -149199,8 +148531,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -150007,11 +149339,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -150106,7 +149438,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &887
+ milestone: &882
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -150244,8 +149576,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -150344,8 +149676,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -151134,11 +150466,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -151255,9 +150587,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *876
- organization: *857
- repository: *858
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -151337,8 +150669,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -152126,11 +151458,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -152247,9 +151579,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *876
- organization: *857
- repository: *858
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -152329,8 +151661,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -153142,11 +152474,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -153240,8 +152572,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -153320,8 +152652,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -154127,11 +153459,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -154225,9 +153557,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *887
- organization: *857
- repository: *858
+ milestone: *882
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -155095,11 +154427,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -155661,8 +154993,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -156451,11 +155783,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -156571,8 +155903,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -156652,9 +155984,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *855
- installation: *856
- issue: &888
+ enterprise: *850
+ installation: *851
+ issue: &883
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
itself.
@@ -157437,11 +156769,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -157557,8 +156889,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -157637,8 +156969,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -158448,11 +157780,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -158547,8 +157879,8 @@ x-webhooks:
user_view_type:
type: string
type: *371
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -159414,11 +158746,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -160002,11 +159334,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *855
- installation: *856
- issue: *888
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ issue: *883
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -160086,12 +159418,12 @@ x-webhooks:
type: string
enum:
- typed
- enterprise: *855
- installation: *856
- issue: *889
+ enterprise: *850
+ installation: *851
+ issue: *884
type: *371
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -160172,7 +159504,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &918
+ assignee: &913
title: User
type: object
nullable: true
@@ -160242,11 +159574,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *855
- installation: *856
- issue: *889
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ issue: *884
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -160325,12 +159657,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *855
- installation: *856
- issue: *889
- label: *876
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ issue: *884
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -160410,8 +159742,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue)
@@ -161221,11 +160553,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *793
- issue_dependencies_summary: *794
+ sub_issues_summary: *790
+ issue_dependencies_summary: *791
issue_field_values:
type: array
- items: *795
+ items: *792
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -161319,8 +160651,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161400,11 +160732,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *855
- installation: *856
- issue: *888
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ issue: *883
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161483,12 +160815,12 @@ x-webhooks:
type: string
enum:
- untyped
- enterprise: *855
- installation: *856
- issue: *889
+ enterprise: *850
+ installation: *851
+ issue: *884
type: *371
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161568,11 +160900,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- label: *876
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161650,11 +160982,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- label: *876
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161764,11 +161096,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- label: *876
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ label: *871
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -161850,9 +161182,9 @@ x-webhooks:
- cancelled
effective_date:
type: string
- enterprise: *855
- installation: *856
- marketplace_purchase: &890
+ enterprise: *850
+ installation: *851
+ marketplace_purchase: &885
title: Marketplace Purchase
type: object
required:
@@ -161935,8 +161267,8 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *857
- previous_marketplace_purchase: &891
+ organization: *852
+ previous_marketplace_purchase: &886
title: Marketplace Purchase
type: object
properties:
@@ -162016,7 +161348,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -162096,10 +161428,10 @@ x-webhooks:
- changed
effective_date:
type: string
- enterprise: *855
- installation: *856
- marketplace_purchase: *890
- organization: *857
+ enterprise: *850
+ installation: *851
+ marketplace_purchase: *885
+ organization: *852
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162182,7 +161514,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -162264,10 +161596,10 @@ x-webhooks:
- pending_change
effective_date:
type: string
- enterprise: *855
- installation: *856
- marketplace_purchase: *890
- organization: *857
+ enterprise: *850
+ installation: *851
+ marketplace_purchase: *885
+ organization: *852
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162349,7 +161681,7 @@ x-webhooks:
- on_free_trial
- free_trial_ends_on
- plan
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -162430,8 +161762,8 @@ x-webhooks:
- pending_change_cancelled
effective_date:
type: string
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -162513,9 +161845,9 @@ x-webhooks:
type: integer
unit_count:
type: integer
- organization: *857
- previous_marketplace_purchase: *891
- repository: *858
+ organization: *852
+ previous_marketplace_purchase: *886
+ repository: *853
sender: *4
required:
- action
@@ -162595,12 +161927,12 @@ x-webhooks:
- purchased
effective_date:
type: string
- enterprise: *855
- installation: *856
- marketplace_purchase: *890
- organization: *857
- previous_marketplace_purchase: *891
- repository: *858
+ enterprise: *850
+ installation: *851
+ marketplace_purchase: *885
+ organization: *852
+ previous_marketplace_purchase: *886
+ repository: *853
sender: *4
required:
- action
@@ -162702,11 +162034,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -162806,11 +162138,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -162889,11 +162221,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -162971,11 +162303,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -163051,7 +162383,7 @@ x-webhooks:
required:
- login
- id
- team: &892
+ team: &887
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -163274,11 +162606,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *855
- installation: *856
- member: *882
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ member: *877
+ organization: *852
+ repository: *853
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -163355,7 +162687,7 @@ x-webhooks:
required:
- login
- id
- team: *892
+ team: *887
required:
- action
- scope
@@ -163437,8 +162769,8 @@ x-webhooks:
type: string
enum:
- checks_requested
- installation: *856
- merge_group: &894
+ installation: *851
+ merge_group: &889
type: object
title: Merge Group
description: A group of pull requests that the merge queue has grouped
@@ -163457,15 +162789,15 @@ x-webhooks:
description: The full ref of the branch the merge group will
be merged into.
type: string
- head_commit: *893
+ head_commit: *888
required:
- head_sha
- head_ref
- base_sha
- base_ref
- head_commit
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -163551,10 +162883,10 @@ x-webhooks:
- merged
- invalidated
- dequeued
- installation: *856
- merge_group: *894
- organization: *857
- repository: *858
+ installation: *851
+ merge_group: *889
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -163627,7 +162959,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
+ enterprise: *850
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -163736,16 +163068,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *895
- required: *896
+ properties: *890
+ required: *891
nullable: true
sender: *4
required:
@@ -163826,11 +163158,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *855
- installation: *856
- milestone: *887
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ milestone: *882
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -163909,9 +163241,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- milestone: &897
+ enterprise: *850
+ installation: *851
+ milestone: &892
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -164048,8 +163380,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164128,11 +163460,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- milestone: *887
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ milestone: *882
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164242,11 +163574,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- milestone: *887
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ milestone: *882
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164326,11 +163658,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *855
- installation: *856
- milestone: *897
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ milestone: *892
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164409,11 +163741,11 @@ x-webhooks:
type: string
enum:
- blocked
- blocked_user: *882
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ blocked_user: *877
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164492,11 +163824,11 @@ x-webhooks:
type: string
enum:
- unblocked
- blocked_user: *882
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ blocked_user: *877
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -164572,7 +163904,7 @@ x-webhooks:
enum:
- created
definition: *151
- enterprise: *855
+ enterprise: *850
sender: *4
required:
- action
@@ -164652,8 +163984,8 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
sender: *4
required:
- action
@@ -164726,8 +164058,8 @@ x-webhooks:
enum:
- updated
definition: *151
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
sender: *4
required:
- action
@@ -164799,9 +164131,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
new_property_values:
type: array
@@ -164889,9 +164221,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- membership: &898
+ enterprise: *850
+ installation: *851
+ membership: &893
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -164998,8 +164330,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -165077,11 +164409,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *855
- installation: *856
- membership: *898
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ membership: *893
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -165160,8 +164492,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -165277,10 +164609,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
- user: *882
+ user: *877
required:
- action
- invitation
@@ -165358,11 +164690,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *855
- installation: *856
- membership: *898
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ membership: *893
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -165449,11 +164781,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *855
- installation: *856
- membership: *898
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ membership: *893
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -165529,9 +164861,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
package:
description: Information about the package.
type: object
@@ -166030,7 +165362,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &899
+ items: &894
title: Ruby Gems metadata
type: object
properties:
@@ -166125,7 +165457,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -166201,9 +165533,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
package:
description: Information about the package.
type: object
@@ -166556,7 +165888,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *899
+ items: *894
source_url:
type: string
format: uri
@@ -166626,7 +165958,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -166803,12 +166135,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *855
+ enterprise: *850
id:
type: integer
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- id
@@ -166885,7 +166217,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &900
+ personal_access_token_request: &895
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -167031,10 +166363,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *855
- organization: *857
+ enterprise: *850
+ organization: *852
sender: *4
- installation: *856
+ installation: *851
required:
- action
- personal_access_token_request
@@ -167111,11 +166443,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *900
- enterprise: *855
- organization: *857
+ personal_access_token_request: *895
+ enterprise: *850
+ organization: *852
sender: *4
- installation: *856
+ installation: *851
required:
- action
- personal_access_token_request
@@ -167191,11 +166523,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *900
- enterprise: *855
- organization: *857
+ personal_access_token_request: *895
+ enterprise: *850
+ organization: *852
sender: *4
- installation: *856
+ installation: *851
required:
- action
- personal_access_token_request
@@ -167270,11 +166602,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *900
- organization: *857
- enterprise: *855
+ personal_access_token_request: *895
+ organization: *852
+ enterprise: *850
sender: *4
- installation: *856
+ installation: *851
required:
- action
- personal_access_token_request
@@ -167379,7 +166711,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *901
+ last_response: *896
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -167411,8 +166743,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
zen:
description: Random string of GitHub zen.
@@ -167657,10 +166989,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *855
- installation: *856
- organization: *857
- project_card: &902
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_card: &897
title: Project Card
type: object
properties:
@@ -167779,7 +167111,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -167860,11 +167192,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- project_card: *902
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_card: *897
+ repository: *853
sender: *4
required:
- action
@@ -167944,9 +167276,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
project_card:
title: Project Card
type: object
@@ -168074,8 +167406,8 @@ x-webhooks:
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *895
- required: *896
+ properties: *890
+ required: *891
nullable: true
sender: *4
required:
@@ -168169,11 +167501,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *855
- installation: *856
- organization: *857
- project_card: *902
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_card: *897
+ repository: *853
sender: *4
required:
- action
@@ -168267,9 +167599,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
project_card:
allOf:
- title: Project Card
@@ -168459,7 +167791,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -168539,10 +167871,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *855
- installation: *856
- organization: *857
- project: &904
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: &899
title: Project
type: object
properties:
@@ -168666,7 +167998,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -168746,10 +168078,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- project_column: &903
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_column: &898
title: Project Column
type: object
properties:
@@ -168788,7 +168120,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -168867,18 +168199,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- project_column: *903
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_column: *898
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *895
- required: *896
+ properties: *890
+ required: *891
nullable: true
sender: *4
required:
@@ -168968,11 +168300,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- project_column: *903
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_column: *898
+ repository: *853
sender: *4
required:
- action
@@ -169052,11 +168384,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *855
- installation: *856
- organization: *857
- project_column: *903
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project_column: *898
+ repository: *853
sender: *4
required:
- action
@@ -169136,11 +168468,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- project: *904
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: *899
+ repository: *853
sender: *4
required:
- action
@@ -169220,18 +168552,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- project: *904
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: *899
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *895
- required: *896
+ properties: *890
+ required: *891
nullable: true
sender: *4
required:
@@ -169333,11 +168665,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- project: *904
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: *899
+ repository: *853
sender: *4
required:
- action
@@ -169416,11 +168748,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *855
- installation: *856
- organization: *857
- project: *904
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ project: *899
+ repository: *853
sender: *4
required:
- action
@@ -169501,8 +168833,8 @@ x-webhooks:
type: string
enum:
- closed
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -169584,8 +168916,8 @@ x-webhooks:
type: string
enum:
- created
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -169667,8 +168999,8 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -169786,8 +169118,8 @@ x-webhooks:
type: string
to:
type: string
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -169871,7 +169203,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &908
+ changes: &903
type: object
properties:
archived_at:
@@ -169885,9 +169217,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *856
- organization: *857
- projects_v2_item: &905
+ installation: *851
+ organization: *852
+ projects_v2_item: &900
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -170022,9 +169354,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170106,9 +169438,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170189,9 +169521,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170297,7 +169629,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &906
+ - &901
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -170319,7 +169651,7 @@ x-webhooks:
required:
- id
- name
- - &907
+ - &902
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -170353,8 +169685,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *906
- - *907
+ - *901
+ - *902
required:
- field_value
- type: object
@@ -170370,9 +169702,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170467,9 +169799,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *856
- organization: *857
- projects_v2_item: *905
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170552,10 +169884,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *908
- installation: *856
- organization: *857
- projects_v2_item: *905
+ changes: *903
+ installation: *851
+ organization: *852
+ projects_v2_item: *900
sender: *4
required:
- action
@@ -170637,8 +169969,8 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
projects_v2: *403
sender: *4
required:
@@ -170720,14 +170052,14 @@ x-webhooks:
type: string
enum:
- created
- installation: *856
- organization: *857
- projects_v2_status_update: &911
+ installation: *851
+ organization: *852
+ projects_v2_status_update: &906
title: Projects v2 Status Update
description: An status update belonging to a project
type: object
- properties: *909
- required: *910
+ properties: *904
+ required: *905
sender: *4
required:
- action
@@ -170808,9 +170140,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *856
- organization: *857
- projects_v2_status_update: *911
+ installation: *851
+ organization: *852
+ projects_v2_status_update: *906
sender: *4
required:
- action
@@ -170946,9 +170278,9 @@ x-webhooks:
type: string
format: date
nullable: true
- installation: *856
- organization: *857
- projects_v2_status_update: *911
+ installation: *851
+ organization: *852
+ projects_v2_status_update: *906
sender: *4
required:
- action
@@ -171019,10 +170351,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- repository
@@ -171099,13 +170431,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *882
- enterprise: *855
- installation: *856
- number: &912
+ assignee: *877
+ enterprise: *850
+ installation: *851
+ number: &907
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -173388,7 +172720,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -173470,11 +172802,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -175752,7 +175084,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -175834,11 +175166,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -178116,7 +177448,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -178198,13 +177530,13 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: &913
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: &908
allOf:
- - *701
+ - *698
- type: object
properties:
allow_auto_merge:
@@ -178266,7 +177598,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -178347,12 +177679,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -178432,11 +177764,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *855
- milestone: *683
- number: *912
- organization: *857
- pull_request: &914
+ enterprise: *850
+ milestone: *680
+ number: *907
+ organization: *852
+ pull_request: &909
title: Pull Request
type: object
properties:
@@ -180699,7 +180031,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -180778,11 +180110,11 @@ x-webhooks:
type: string
enum:
- dequeued
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -183064,7 +182396,7 @@ x-webhooks:
- BRANCH_PROTECTIONS
- GIT_TREE_INVALID
- INVALID_MERGE_COMMIT
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -183188,12 +182520,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -183273,11 +182605,11 @@ x-webhooks:
type: string
enum:
- enqueued
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -185544,7 +184876,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -185624,11 +184956,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *855
- installation: *856
- label: *876
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ label: *871
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -187910,7 +187242,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -187991,10 +187323,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -190274,7 +189606,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -190354,12 +189686,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *855
- milestone: *683
- number: *912
- organization: *857
- pull_request: *914
- repository: *858
+ enterprise: *850
+ milestone: *680
+ number: *907
+ organization: *852
+ pull_request: *909
+ repository: *853
sender: *4
required:
- action
@@ -190438,12 +189770,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -190524,12 +189856,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -190609,12 +189941,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
- pull_request: *913
- repository: *858
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
+ pull_request: *908
+ repository: *853
sender: *4
required:
- action
@@ -190980,9 +190312,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
type: object
properties:
@@ -193152,7 +192484,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -193232,7 +192564,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &916
+ comment: &911
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -193517,9 +192849,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
type: object
properties:
@@ -195677,7 +195009,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -195757,11 +195089,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *915
- comment: *916
- enterprise: *855
- installation: *856
- organization: *857
+ changes: *910
+ comment: *911
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
type: object
properties:
@@ -197922,7 +197254,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -198003,9 +197335,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -200178,7 +199510,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
+ repository: *853
review:
description: The review that was affected.
type: object
@@ -200425,9 +199757,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -202481,8 +201813,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
- review: &917
+ repository: *853
+ review: &912
description: The review that was affected.
type: object
properties:
@@ -202715,12 +202047,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -205003,7 +204335,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
requested_reviewer:
title: User
type: object
@@ -205087,12 +204419,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -207382,7 +206714,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -207574,12 +206906,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -209864,7 +209196,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
requested_reviewer:
title: User
type: object
@@ -209949,12 +209281,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *855
- installation: *856
+ enterprise: *850
+ installation: *851
number:
description: The pull request number.
type: integer
- organization: *857
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -212230,7 +211562,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -212411,9 +211743,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -214588,8 +213920,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
- review: *917
+ repository: *853
+ review: *912
sender: *4
required:
- action
@@ -214669,9 +214001,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -216741,7 +216073,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
thread:
type: object
@@ -217128,9 +216460,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
pull_request:
title: Simple Pull Request
type: object
@@ -219186,7 +218518,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *858
+ repository: *853
sender: *4
thread:
type: object
@@ -219576,10 +218908,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -221850,7 +221182,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -221932,11 +221264,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *918
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
+ assignee: *913
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -224219,7 +223551,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -224298,11 +223630,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *855
- installation: *856
- label: *876
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ label: *871
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -226575,7 +225907,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -226656,10 +225988,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *855
- installation: *856
- number: *912
- organization: *857
+ enterprise: *850
+ installation: *851
+ number: *907
+ organization: *852
pull_request:
title: Pull Request
type: object
@@ -228924,7 +228256,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -229124,7 +228456,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *855
+ enterprise: *850
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -229216,8 +228548,8 @@ x-webhooks:
- url
- author
- committer
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -229792,9 +229124,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
registry_package:
type: object
properties:
@@ -230240,7 +229572,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *899
+ items: *894
summary:
type: string
tag_name:
@@ -230294,7 +229626,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -230372,9 +229704,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
registry_package:
type: object
properties:
@@ -230682,7 +230014,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *899
+ items: *894
summary:
type: string
tag_name:
@@ -230731,7 +230063,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -230808,10 +230140,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- release: &919
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: &914
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -231129,7 +230461,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -231206,11 +230538,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- release: *919
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: *914
+ repository: *853
sender: *4
required:
- action
@@ -231327,11 +230659,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *855
- installation: *856
- organization: *857
- release: *919
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: *914
+ repository: *853
sender: *4
required:
- action
@@ -231409,9 +230741,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
release:
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
@@ -231733,7 +231065,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -231809,10 +231141,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
- release: &920
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: &915
title: Release
description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release)
object.
@@ -232131,7 +231463,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *858
+ repository: *853
sender: *4
required:
- action
@@ -232207,11 +231539,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *855
- installation: *856
- organization: *857
- release: *919
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: *914
+ repository: *853
sender: *4
required:
- action
@@ -232287,11 +231619,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *855
- installation: *856
- organization: *857
- release: *920
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ release: *915
+ repository: *853
sender: *4
required:
- action
@@ -232367,11 +231699,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- repository_advisory: *753
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ repository_advisory: *750
sender: *4
required:
- action
@@ -232447,11 +231779,11 @@ x-webhooks:
type: string
enum:
- reported
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- repository_advisory: *753
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ repository_advisory: *750
sender: *4
required:
- action
@@ -232527,10 +231859,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232607,10 +231939,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232688,10 +232020,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232775,10 +232107,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232890,10 +232222,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -232965,10 +232297,10 @@ x-webhooks:
title: repository_import event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
status:
type: string
@@ -233049,10 +232381,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233129,10 +232461,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233226,10 +232558,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233309,10 +232641,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
repository_ruleset: *191
sender: *4
required:
@@ -233391,10 +232723,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
repository_ruleset: *191
sender: *4
required:
@@ -233473,10 +232805,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
repository_ruleset: *191
changes:
type: object
@@ -233538,16 +232870,16 @@ x-webhooks:
properties:
added:
type: array
- items: *721
+ items: *718
deleted:
type: array
- items: *721
+ items: *718
updated:
type: array
items:
type: object
properties:
- rule: *721
+ rule: *718
changes:
type: object
properties:
@@ -233781,10 +233113,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233862,10 +233194,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -233943,7 +233275,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &921
+ alert: &916
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -234064,10 +233396,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234273,10 +233605,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234354,11 +233686,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *921
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *916
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234557,10 +233889,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234638,7 +233970,7 @@ x-webhooks:
type: string
enum:
- assigned
- alert: &922
+ alert: &917
type: object
properties:
number: *128
@@ -234757,10 +234089,10 @@ x-webhooks:
required: *21
nullable: true
assignee: *4
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234838,11 +234170,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -234923,11 +234255,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *922
- installation: *856
- location: *923
- organization: *857
- repository: *858
+ alert: *917
+ installation: *851
+ location: *918
+ organization: *852
+ repository: *853
sender: *4
required:
- location
@@ -235165,11 +234497,11 @@ x-webhooks:
type: string
enum:
- publicly_leaked
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235247,11 +234579,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235329,11 +234661,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235411,12 +234743,12 @@ x-webhooks:
type: string
enum:
- unassigned
- alert: *922
+ alert: *917
assignee: *4
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235494,11 +234826,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *922
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ alert: *917
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -235624,10 +234956,10 @@ x-webhooks:
- organization
- enterprise
nullable: true
- repository: *858
- enterprise: *855
- installation: *856
- organization: *857
+ repository: *853
+ enterprise: *850
+ installation: *851
+ organization: *852
sender: *4
required:
- action
@@ -235705,11 +235037,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- security_advisory: &924
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ security_advisory: &919
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -235892,11 +235224,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
- security_advisory: *924
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
+ security_advisory: *919
sender: *4
required:
- action
@@ -235969,10 +235301,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -236157,10 +235489,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *419
- enterprise: *855
- installation: *856
- organization: *857
- repository: *464
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *461
sender: *4
required:
- changes
@@ -236238,12 +235570,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: &925
+ sponsorship: &920
type: object
properties:
created_at:
@@ -236544,12 +235876,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- sponsorship
@@ -236637,12 +235969,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- changes
@@ -236719,17 +236051,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &926
+ effective_date: &921
description: The `pending_cancellation` and `pending_tier_change`
event types will include the date the cancellation or tier change
will take effect.
type: string
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- sponsorship
@@ -236803,7 +236135,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &927
+ changes: &922
type: object
properties:
tier:
@@ -236847,13 +236179,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *926
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ effective_date: *921
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- changes
@@ -236930,13 +236262,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *927
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ changes: *922
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- sponsorship: *925
+ sponsorship: *920
required:
- action
- changes
@@ -237010,10 +236342,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -237096,10 +236428,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -237519,15 +236851,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *855
+ enterprise: *850
id:
description: The unique identifier of the status.
type: integer
- installation: *856
+ installation: *851
name:
type: string
- organization: *857
- repository: *858
+ organization: *852
+ repository: *853
sender: *4
sha:
description: The Commit SHA.
@@ -237642,9 +236974,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -237734,9 +237066,9 @@ x-webhooks:
description: The ID of the sub-issue.
type: number
sub_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -237826,9 +237158,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -237918,9 +237250,9 @@ x-webhooks:
description: The ID of the parent issue.
type: number
parent_issue: *221
- installation: *856
- organization: *857
- repository: *858
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -237997,12 +237329,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- team: &928
+ team: &923
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -238225,9 +237557,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -238685,7 +238017,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- team
@@ -238761,9 +238093,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -239221,7 +238553,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- team
@@ -239298,9 +238630,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -239758,7 +239090,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- team
@@ -239902,9 +239234,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -240362,7 +239694,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- changes
@@ -240440,9 +239772,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *855
- installation: *856
- organization: *857
+ enterprise: *850
+ installation: *851
+ organization: *852
repository:
title: Repository
description: A git repository
@@ -240900,7 +240232,7 @@ x-webhooks:
- topics
- visibility
sender: *4
- team: *928
+ team: *923
required:
- action
- team
@@ -240976,10 +240308,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
required:
- action
@@ -241052,16 +240384,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *855
+ enterprise: *850
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *856
- organization: *857
+ installation: *851
+ organization: *852
ref:
type: string
- repository: *858
+ repository: *853
sender: *4
workflow:
type: string
@@ -241143,10 +240475,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
workflow_job:
allOf:
@@ -241383,7 +240715,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *603
+ deployment: *600
required:
- action
- repository
@@ -241462,10 +240794,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
workflow_job:
allOf:
@@ -241725,7 +241057,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *603
+ deployment: *600
required:
- action
- repository
@@ -241804,10 +241136,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
workflow_job:
type: object
@@ -241942,7 +241274,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *603
+ deployment: *600
required:
- action
- repository
@@ -242021,10 +241353,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
workflow_job:
type: object
@@ -242160,7 +241492,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *603
+ deployment: *600
required:
- action
- repository
@@ -242240,12 +241572,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: *872
+ workflow: *867
workflow_run:
title: Workflow Run
type: object
@@ -243244,12 +242576,12 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: *872
+ workflow: *867
workflow_run:
title: Workflow Run
type: object
@@ -244233,12 +243565,12 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *855
- installation: *856
- organization: *857
- repository: *858
+ enterprise: *850
+ installation: *851
+ organization: *852
+ repository: *853
sender: *4
- workflow: *872
+ workflow: *867
workflow_run:
title: Workflow Run
type: object
diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json
index 8d67d3d30..719d25a57 100644
--- a/descriptions/ghec/ghec.2022-11-28.json
+++ b/descriptions/ghec/ghec.2022-11-28.json
@@ -40683,313 +40683,6 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
- "get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- },
- {
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "post": {
- "summary": "Create a discussion",
- "description": "Creates 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\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- }
- ],
- "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": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
"/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
"summary": "List a connection between an external group and a team",
@@ -80054,304 +79747,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "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": [
- {
- "$ref": "#/components/parameters/team-id"
- }
- ],
- "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": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "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": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
@@ -141121,104 +140516,6 @@
"organization"
]
},
- "team-discussion": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/components/schemas/nullable-simple-user"
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "$ref": "#/components/schemas/reaction-rollup"
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
"team-membership": {
"title": "Team Membership",
"description": "Team Membership",
@@ -313821,158 +313118,6 @@
}
}
},
- "team-discussion-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": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- },
- "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",
- "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",
- "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-membership-response-if-user-is-a-team-maintainer": {
"summary": "Response if user is a team maintainer",
"value": {
@@ -335873,15 +335018,6 @@
"type": "string"
}
},
- "discussion-number": {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
"security-product": {
"name": "security_product",
"in": "path",
diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml
index d3355d8e3..d53fb404c 100644
--- a/descriptions/ghec/ghec.2022-11-28.yaml
+++ b/descriptions/ghec/ghec.2022-11-28.yaml
@@ -29357,231 +29357,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- 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:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -57936,235 +57711,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- 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]
- > **Endpoint closing down notice:** 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.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- 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:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- 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]
- > **Endpoint closing down notice:** 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.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth 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:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -103323,89 +102869,6 @@ components:
- members_count
- repos_count
- organization
- team-discussion:
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form conversation
- within a team.
- type: object
- properties:
- author:
- "$ref": "#/components/schemas/nullable-simple-user"
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a team
"
- body_version:
- description: The current version of the body content. If provided, this
- update operation will be rejected if the given version does not match
- the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted to team
- members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions:
- "$ref": "#/components/schemas/reaction-rollup"
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
team-membership:
title: Team Membership
description: Team Membership
@@ -235022,144 +234485,6 @@ components:
created_at: '2008-01-14T04:33:35Z'
updated_at: '2017-08-17T12:37:15Z'
type: Organization
- team-discussion-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: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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
- 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-membership-response-if-user-is-a-team-maintainer:
summary: Response if user is a team maintainer
value:
@@ -254023,13 +253348,6 @@ components:
required: false
schema:
type: string
- discussion-number:
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
security-product:
name: security_product
in: path
diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json
index 8d67d3d30..719d25a57 100644
--- a/descriptions/ghec/ghec.json
+++ b/descriptions/ghec/ghec.json
@@ -40683,313 +40683,6 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
- "get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- },
- {
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "post": {
- "summary": "Create a discussion",
- "description": "Creates 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\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- }
- ],
- "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": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- },
- "delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/org"
- },
- {
- "$ref": "#/components/parameters/team-slug"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
"/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
"summary": "List a connection between an external group and a team",
@@ -80054,304 +79747,6 @@
"deprecated": true
}
},
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/direction"
- },
- {
- "$ref": "#/components/parameters/per-page"
- },
- {
- "$ref": "#/components/parameters/page"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/team-discussion"
- }
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-items"
- }
- }
- }
- },
- "headers": {
- "Link": {
- "$ref": "#/components/headers/link"
- }
- }
- }
- },
- "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": [
- {
- "$ref": "#/components/parameters/team-id"
- }
- ],
- "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": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion"
- }
- }
- }
- }
- }
- },
- "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": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/team-discussion"
- },
- "examples": {
- "default": {
- "$ref": "#/components/examples/team-discussion-2"
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy"
- },
- "parameters": [
- {
- "$ref": "#/components/parameters/team-id"
- },
- {
- "$ref": "#/components/parameters/discussion-number"
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
"/teams/{team_id}/invitations": {
"get": {
"summary": "List pending team invitations (Legacy)",
@@ -141121,104 +140516,6 @@
"organization"
]
},
- "team-discussion": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/components/schemas/nullable-simple-user"
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "$ref": "#/components/schemas/reaction-rollup"
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
"team-membership": {
"title": "Team Membership",
"description": "Team Membership",
@@ -313821,158 +313118,6 @@
}
}
},
- "team-discussion-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": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- },
- "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",
- "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",
- "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-membership-response-if-user-is-a-team-maintainer": {
"summary": "Response if user is a team maintainer",
"value": {
@@ -335873,15 +335018,6 @@
"type": "string"
}
},
- "discussion-number": {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
"security-product": {
"name": "security_product",
"in": "path",
diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml
index d3355d8e3..d53fb404c 100644
--- a/descriptions/ghec/ghec.yaml
+++ b/descriptions/ghec/ghec.yaml
@@ -29357,231 +29357,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- 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:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion
- parameters:
- - "$ref": "#/components/parameters/org"
- - "$ref": "#/components/parameters/team-slug"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -57936,235 +57711,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/direction"
- - "$ref": "#/components/parameters/per-page"
- - "$ref": "#/components/parameters/page"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-items"
- headers:
- Link:
- "$ref": "#/components/headers/link"
- 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]
- > **Endpoint closing down notice:** 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.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- 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:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion"
- 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]
- > **Endpoint closing down notice:** 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.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth 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:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/team-discussion"
- examples:
- default:
- "$ref": "#/components/examples/team-discussion-2"
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** 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.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - "$ref": "#/components/parameters/team-id"
- - "$ref": "#/components/parameters/discussion-number"
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/invitations":
get:
summary: List pending team invitations (Legacy)
@@ -103323,89 +102869,6 @@ components:
- members_count
- repos_count
- organization
- team-discussion:
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form conversation
- within a team.
- type: object
- properties:
- author:
- "$ref": "#/components/schemas/nullable-simple-user"
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a team
"
- body_version:
- description: The current version of the body content. If provided, this
- update operation will be rejected if the given version does not match
- the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted to team
- members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions:
- "$ref": "#/components/schemas/reaction-rollup"
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
team-membership:
title: Team Membership
description: Team Membership
@@ -235022,144 +234485,6 @@ components:
created_at: '2008-01-14T04:33:35Z'
updated_at: '2017-08-17T12:37:15Z'
type: Organization
- team-discussion-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: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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
- 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-membership-response-if-user-is-a-team-maintainer:
summary: Response if user is a team maintainer
value:
@@ -254023,13 +253348,6 @@ components:
required: false
schema:
type: string
- discussion-number:
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
security-product:
name: security_product
in: path
diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
index 9c63e085d..aa56d88aa 100644
--- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
+++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json
@@ -182100,17 +182100,17 @@
}
}
},
- "/orgs/{org}/teams/{team_slug}/discussions": {
+ "/orgs/{org}/teams/{team_slug}/external-groups": {
"get": {
- "summary": "List discussions",
- "description": "List all discussions on a team's page.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
+ "summary": "List a connection between an external group and a team",
+ "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
- "operationId": "teams/list-discussions-in-org",
+ "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
},
"parameters": [
{
@@ -182130,19 +182130,395 @@
"schema": {
"type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroups",
+ "description": "A list of external groups available to be connected to a team",
+ "type": "object",
+ "properties": {
+ "groups": {
+ "description": "An array of external groups available to be mapped to a team",
+ "example": [
+ {
+ "group_id": 1,
+ "group_name": "group-azuread-test",
+ "updated_at": "2021-01-03 22:27:15:000 -700"
+ },
+ {
+ "group_id": 2,
+ "group_name": "group-azuread-test2",
+ "updated_at": "2021-06-03 22:27:15:000 -700"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "updated_at"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name of the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The time of the last update for this group",
+ "example": "2019-06-03 22:27:15:000 -700",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00"
+ },
+ {
+ "group_id": "456",
+ "group_name": "Octocat docs members",
+ "updated_at": "2021-03-24T11:31:04-06:00"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "patch": {
+ "summary": "Update the connection between an external group and a team",
+ "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/link-external-idp-group-to-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
},
{
- "name": "direction",
- "description": "The direction to sort the results by.",
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "group_id": {
+ "type": "integer",
+ "description": "External Group Id",
+ "example": 1
+ }
+ },
+ "required": [
+ "group_id"
+ ]
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "ExternalGroup",
+ "description": "Information about an external group's usage and its members",
+ "type": "object",
+ "required": [
+ "group_id",
+ "group_name",
+ "teams",
+ "members"
+ ],
+ "properties": {
+ "group_id": {
+ "description": "The internal ID of the group",
+ "example": 1,
+ "type": "integer"
+ },
+ "group_name": {
+ "description": "The display name for the group",
+ "example": "group-azuread-test",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "The date when the group was last updated_at",
+ "example": "2021-01-03 22:27:15:000 -700",
+ "type": "string"
+ },
+ "teams": {
+ "description": "An array of teams linked to this group",
+ "example": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "team_id",
+ "team_name"
+ ],
+ "properties": {
+ "team_id": {
+ "description": "The id for a team",
+ "example": 1,
+ "type": "integer"
+ },
+ "team_name": {
+ "description": "The name of the team",
+ "example": "team-test",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "members": {
+ "description": "An array of external members linked to this group",
+ "example": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ],
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "member_id",
+ "member_login",
+ "member_name",
+ "member_email"
+ ],
+ "properties": {
+ "member_id": {
+ "description": "The internal user ID of the identity",
+ "example": 1,
+ "type": "integer"
+ },
+ "member_login": {
+ "description": "The handle/login for the user",
+ "example": "mona-lisa_eocsaxrs",
+ "type": "string"
+ },
+ "member_name": {
+ "description": "The user display name/profile name",
+ "example": "Mona Lisa",
+ "type": "string"
+ },
+ "member_email": {
+ "description": "An email attached to a user",
+ "example": "mona_lisa@github.com",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "updated_at": "2021-01-24T11:31:04-06:00",
+ "teams": [
+ {
+ "team_id": 1,
+ "team_name": "team-test"
+ },
+ {
+ "team_id": 2,
+ "team_name": "team-test2"
+ }
+ ],
+ "members": [
+ {
+ "member_id": 1,
+ "member_login": "mona-lisa_eocsaxrs",
+ "member_name": "Mona Lisa",
+ "member_email": "mona_lisa@github.com"
+ },
+ {
+ "member_id": 2,
+ "member_login": "octo-lisa_eocsaxrs",
+ "member_name": "Octo Lisa",
+ "member_email": "octo_lisa@github.com"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ },
+ "delete": {
+ "summary": "Remove the connection between an external group and a team",
+ "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/unlink-external-idp-group-from-team-for-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": true,
+ "enabledForGitHubApps": false,
+ "category": "teams",
+ "subcategory": "external-groups"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/members": {
+ "get": {
+ "summary": "List team members",
+ "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-members-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "role",
+ "description": "Filters members returned by their role in the team.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
- "asc",
- "desc"
+ "member",
+ "maintainer",
+ "all"
],
- "default": "desc"
+ "default": "all"
}
},
{
@@ -182162,15 +182538,529 @@
"type": "integer",
"default": 1
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "nullable": true,
+ "type": "string"
+ },
+ "email": {
+ "nullable": true,
+ "type": "string"
+ },
+ "login": {
+ "type": "string",
+ "example": "octocat"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDQ6VXNlcjE="
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/images/error/octocat_happy.gif"
+ },
+ "gravatar_id": {
+ "type": "string",
+ "example": "41d064eb2195891e12d0413f63227ea7",
+ "nullable": true
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://github.com/octocat"
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/followers"
+ },
+ "following_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/following{/other_user}"
+ },
+ "gists_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ },
+ "starred_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/subscriptions"
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/orgs"
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/repos"
+ },
+ "events_url": {
+ "type": "string",
+ "example": "https://api.github.com/users/octocat/events{/privacy}"
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/users/octocat/received_events"
+ },
+ "type": {
+ "type": "string",
+ "example": "User"
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "example": "\"2020-07-09T00:17:55Z\""
+ },
+ "user_view_type": {
+ "type": "string",
+ "example": "public"
+ }
+ },
+ "required": [
+ "avatar_url",
+ "events_url",
+ "followers_url",
+ "following_url",
+ "gists_url",
+ "gravatar_id",
+ "html_url",
+ "id",
+ "node_id",
+ "login",
+ "organizations_url",
+ "received_events_url",
+ "repos_url",
+ "site_admin",
+ "starred_url",
+ "subscriptions_url",
+ "type",
+ "url"
+ ]
+ }
+ },
+ "examples": {
+ "default": {
+ "value": [
+ {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "headers": {
+ "Link": {
+ "example": "; rel=\"next\", ; rel=\"last\"",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
+ "get": {
+ "summary": "Get team membership for a user",
+ "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/get-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
},
{
- "name": "pinned",
- "in": "query",
- "required": false,
- "description": "Pinned discussions only filter",
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Membership",
+ "description": "Team Membership",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of the user's membership in the team.",
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "role",
+ "state",
+ "url"
+ ]
+ },
+ "examples": {
+ "response-if-user-is-a-team-maintainer": {
+ "summary": "Response if user is a team maintainer",
+ "value": {
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "maintainer",
+ "state": "active"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "if user has no team membership"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "put": {
+ "summary": "Add or update team membership for a user",
+ "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/add-or-update-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": false,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "The role that this user should have in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member"
+ }
+ }
+ },
+ "examples": {
+ "default": {
+ "summary": "Add or update team membership for an organization member",
+ "value": {
+ "role": "maintainer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Team Membership",
+ "description": "Team Membership",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "role": {
+ "description": "The role of the user in the team.",
+ "enum": [
+ "member",
+ "maintainer"
+ ],
+ "default": "member",
+ "example": "member",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of the user's membership in the team.",
+ "type": "string",
+ "enum": [
+ "active",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "role",
+ "state",
+ "url"
+ ]
+ },
+ "examples": {
+ "response-if-users-membership-with-team-is-now-pending": {
+ "summary": "Response if user's membership with team is now pending",
+ "value": {
+ "url": "https://api.github.com/teams/1/memberships/octocat",
+ "role": "member",
+ "state": "pending"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
+ },
+ "422": {
+ "description": "Unprocessable Entity if you attempt to add an organization to a team"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ },
+ "delete": {
+ "summary": "Remove team membership for a user",
+ "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/remove-membership-for-user-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "username",
+ "description": "The handle for the GitHub user account.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if team synchronization is set up"
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "category": "teams",
+ "subcategory": "members"
+ }
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/projects": {
+ "get": {
+ "summary": "List team projects",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
+ "tags": [
+ "teams"
+ ],
+ "operationId": "teams/list-projects-in-org",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects"
+ },
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "team_slug",
+ "description": "The slug of the team name.",
+ "in": "path",
+ "required": true,
"schema": {
"type": "string"
}
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
}
],
"responses": {
@@ -182181,11 +183071,42 @@
"schema": {
"type": "array",
"items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Team Project",
+ "description": "A team's access to a project.",
"type": "object",
"properties": {
- "author": {
+ "owner_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "html_url": {
+ "type": "string"
+ },
+ "columns_url": {
+ "type": "string"
+ },
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "nullable": true
+ },
+ "number": {
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "creator": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -182307,143 +183228,57 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
+ ]
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
+ "created_at": {
"type": "string"
},
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "updated_at": {
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
+ "organization_permission": {
+ "description": "The organization permission for this project. Only present when owner is an organization.",
+ "type": "string"
},
"private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
+ "description": "Whether the project is private or not. Only present when owner is an organization.",
"type": "boolean"
},
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
+ "permissions": {
"type": "object",
"properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
+ "read": {
+ "type": "boolean"
},
- "heart": {
- "type": "integer"
+ "write": {
+ "type": "boolean"
},
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
+ "admin": {
+ "type": "boolean"
}
},
"required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "read",
+ "write",
+ "admin"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
+ "owner_url",
+ "url",
"html_url",
- "pinned",
- "private",
+ "columns_url",
+ "id",
"node_id",
+ "name",
+ "body",
"number",
- "team_url",
- "title",
+ "state",
+ "creator",
+ "created_at",
"updated_at",
- "url"
+ "permissions"
]
}
},
@@ -182451,7 +183286,17 @@
"default": {
"value": [
{
- "author": {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -182471,31 +183316,14 @@
"type": "User",
"site_admin": false
},
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
"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
+ "permissions": {
+ "read": true,
+ "write": true,
+ "admin": false
}
}
]
@@ -182517,19 +183345,24 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
- }
- },
- "post": {
- "summary": "Create a discussion",
- "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
+ }
+ },
+ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
+ "get": {
+ "summary": "Check team permissions for a project",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/create-discussion-in-org",
+ "operationId": "teams/check-permissions-for-project-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project"
},
"parameters": [
{
@@ -182549,433 +183382,59 @@
"schema": {
"type": "string"
}
- }
- ],
- "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."
- }
- }
- }
+ },
+ {
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
}
}
- },
+ ],
"responses": {
- "201": {
+ "200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
+ "title": "Team Project",
+ "description": "A team's access to a project.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
+ "owner_url": {
+ "type": "string"
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
+ "url": {
"type": "string"
},
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
+ "html_url": {
+ "type": "string"
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "columns_url": {
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "id": {
+ "type": "integer"
},
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
+ "node_id": {
+ "type": "string"
},
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
+ "name": {
+ "type": "string"
},
- "node_id": {
+ "body": {
"type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ "nullable": true
},
"number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
"type": "integer"
},
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "state": {
"type": "string"
},
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "discussions"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion",
- "description": "Get a specific discussion on a team's page.\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}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
+ "creator": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
@@ -183097,149 +183556,73 @@
"subscriptions_url",
"type",
"url"
- ],
- "nullable": true
+ ]
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
+ "created_at": {
"type": "string"
},
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "updated_at": {
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
+ "organization_permission": {
+ "description": "The organization permission for this project. Only present when owner is an organization.",
+ "type": "string"
},
"private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
+ "description": "Whether the project is private or not. Only present when owner is an organization.",
"type": "boolean"
},
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
+ "permissions": {
"type": "object",
"properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
+ "read": {
+ "type": "boolean"
},
- "eyes": {
- "type": "integer"
+ "write": {
+ "type": "boolean"
},
- "rocket": {
- "type": "integer"
+ "admin": {
+ "type": "boolean"
}
},
"required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
+ "read",
+ "write",
+ "admin"
]
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
+ "owner_url",
+ "url",
"html_url",
- "pinned",
- "private",
+ "columns_url",
+ "id",
"node_id",
+ "name",
+ "body",
"number",
- "team_url",
- "title",
+ "state",
+ "creator",
+ "created_at",
"updated_at",
- "url"
+ "permissions"
]
},
"examples": {
"default": {
"value": {
- "author": {
+ "owner_url": "https://api.github.com/orgs/octocat",
+ "url": "https://api.github.com/projects/1002605",
+ "html_url": "https://github.com/orgs/api-playground/projects/1",
+ "columns_url": "https://api.github.com/projects/1002605/columns",
+ "id": 1002605,
+ "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year.",
+ "number": 1,
+ "state": "open",
+ "creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
@@ -183259,56 +183642,45 @@
"type": "User",
"site_admin": false
},
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
+ "created_at": "2011-04-11T20:09:31Z",
+ "updated_at": "2014-03-04T18:58:10Z",
+ "organization_permission": "write",
"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
+ "permissions": {
+ "read": true,
+ "write": true,
+ "admin": false
}
}
}
}
}
}
+ },
+ "404": {
+ "description": "Not Found if project is not managed by this team"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
},
- "patch": {
- "summary": "Update a discussion",
- "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "put": {
+ "summary": "Add or update team project permissions",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/update-discussion-in-org",
+ "operationId": "teams/add-or-update-project-permissions-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
},
"parameters": [
{
@@ -183330,8 +183702,8 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
"in": "path",
"required": true,
"schema": {
@@ -183346,20 +183718,23 @@
"schema": {
"type": "object",
"properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
+ "permission": {
"type": "string",
- "description": "The discussion post's body text."
+ "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"",
+ "enum": [
+ "read",
+ "write",
+ "admin"
+ ]
}
- }
+ },
+ "nullable": true
},
"examples": {
"default": {
+ "summary": "Updates the permissions for the team to write for the project",
"value": {
- "title": "Welcome to our first team post"
+ "permission": "write"
}
}
}
@@ -183367,325 +183742,29 @@
}
},
"responses": {
- "200": {
- "description": "Response",
+ "204": {
+ "description": "Response"
+ },
+ "403": {
+ "description": "Forbidden if the project is not owned by the organization",
"content": {
"application/json": {
"schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
"type": "object",
"properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
+ "message": {
"type": "string"
},
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "documentation_url": {
"type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
}
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
+ }
},
"examples": {
- "default": {
+ "response-if-the-project-is-not-owned-by-the-organization": {
"value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "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
- }
+ "message": "Must have admin rights to Repository.",
+ "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
}
}
}
@@ -183697,19 +183776,22 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
},
"delete": {
- "summary": "Delete a discussion",
- "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Remove a project from a team",
+ "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-in-org",
+ "operationId": "teams/remove-project-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team"
},
"parameters": [
{
@@ -183731,8 +183813,8 @@
}
},
{
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
+ "name": "project_id",
+ "description": "The unique identifier of the project.",
"in": "path",
"required": true,
"schema": {
@@ -183749,21 +183831,24 @@
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "teams",
- "subcategory": "discussions"
- }
+ "subcategory": "teams",
+ "deprecationDate": "2024-05-23",
+ "removalDate": "2025-04-01"
+ },
+ "deprecated": true
}
},
- "/orgs/{org}/teams/{team_slug}/external-groups": {
+ "/orgs/{org}/teams/{team_slug}/repos": {
"get": {
- "summary": "List a connection between an external group and a team",
- "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
+ "summary": "List team repositories",
+ "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
"tags": [
"teams"
],
- "operationId": "teams/list-linked-external-idp-groups-to-team-for-org",
+ "operationId": "teams/list-repos-in-org",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories"
},
"parameters": [
{
@@ -183783,6 +183868,24 @@
"schema": {
"type": "string"
}
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
}
],
"responses": {
@@ -183791,1796 +183894,40 @@
"content": {
"application/json": {
"schema": {
- "title": "ExternalGroups",
- "description": "A list of external groups available to be connected to a team",
- "type": "object",
- "properties": {
- "groups": {
- "description": "An array of external groups available to be mapped to a team",
- "example": [
- {
- "group_id": 1,
- "group_name": "group-azuread-test",
- "updated_at": "2021-01-03 22:27:15:000 -700"
- },
- {
- "group_id": 2,
- "group_name": "group-azuread-test2",
- "updated_at": "2021-06-03 22:27:15:000 -700"
- }
- ],
- "type": "array",
- "items": {
+ "type": "array",
+ "items": {
+ "title": "Minimal Repository",
+ "description": "Minimal Repository",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1296269
+ },
+ "node_id": {
+ "type": "string",
+ "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ },
+ "name": {
+ "type": "string",
+ "example": "Hello-World"
+ },
+ "full_name": {
+ "type": "string",
+ "example": "octocat/Hello-World"
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
"type": "object",
- "required": [
- "group_id",
- "group_name",
- "updated_at"
- ],
"properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name of the group",
- "example": "group-azuread-test",
+ "name": {
+ "nullable": true,
"type": "string"
},
- "updated_at": {
- "description": "The time of the last update for this group",
- "example": "2019-06-03 22:27:15:000 -700",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00"
- },
- {
- "group_id": "456",
- "group_name": "Octocat docs members",
- "updated_at": "2021-03-24T11:31:04-06:00"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "patch": {
- "summary": "Update the connection between an external group and a team",
- "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/link-external-idp-group-to-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "group_id": {
- "type": "integer",
- "description": "External Group Id",
- "example": 1
- }
- },
- "required": [
- "group_id"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "group_id": 123
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "ExternalGroup",
- "description": "Information about an external group's usage and its members",
- "type": "object",
- "required": [
- "group_id",
- "group_name",
- "teams",
- "members"
- ],
- "properties": {
- "group_id": {
- "description": "The internal ID of the group",
- "example": 1,
- "type": "integer"
- },
- "group_name": {
- "description": "The display name for the group",
- "example": "group-azuread-test",
- "type": "string"
- },
- "updated_at": {
- "description": "The date when the group was last updated_at",
- "example": "2021-01-03 22:27:15:000 -700",
- "type": "string"
- },
- "teams": {
- "description": "An array of teams linked to this group",
- "example": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "team_id",
- "team_name"
- ],
- "properties": {
- "team_id": {
- "description": "The id for a team",
- "example": 1,
- "type": "integer"
- },
- "team_name": {
- "description": "The name of the team",
- "example": "team-test",
- "type": "string"
- }
- }
- }
- },
- "members": {
- "description": "An array of external members linked to this group",
- "example": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ],
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "member_id",
- "member_login",
- "member_name",
- "member_email"
- ],
- "properties": {
- "member_id": {
- "description": "The internal user ID of the identity",
- "example": 1,
- "type": "integer"
- },
- "member_login": {
- "description": "The handle/login for the user",
- "example": "mona-lisa_eocsaxrs",
- "type": "string"
- },
- "member_name": {
- "description": "The user display name/profile name",
- "example": "Mona Lisa",
- "type": "string"
- },
- "member_email": {
- "description": "An email attached to a user",
- "example": "mona_lisa@github.com",
- "type": "string"
- }
- }
- }
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "group_id": "123",
- "group_name": "Octocat admins",
- "updated_at": "2021-01-24T11:31:04-06:00",
- "teams": [
- {
- "team_id": 1,
- "team_name": "team-test"
- },
- {
- "team_id": 2,
- "team_name": "team-test2"
- }
- ],
- "members": [
- {
- "member_id": 1,
- "member_login": "mona-lisa_eocsaxrs",
- "member_name": "Mona Lisa",
- "member_email": "mona_lisa@github.com"
- },
- {
- "member_id": 2,
- "member_login": "octo-lisa_eocsaxrs",
- "member_name": "Octo Lisa",
- "member_email": "octo_lisa@github.com"
- }
- ]
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- },
- "delete": {
- "summary": "Remove the connection between an external group and a team",
- "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/unlink-external-idp-group-from-team-for-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": true,
- "enabledForGitHubApps": false,
- "category": "teams",
- "subcategory": "external-groups"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/members": {
- "get": {
- "summary": "List team members",
- "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-members-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "role",
- "description": "Filters members returned by their role in the team.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "member",
- "maintainer",
- "all"
- ],
- "default": "all"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/memberships/{username}": {
- "get": {
- "summary": "Get team membership for a user",
- "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-user-is-a-team-maintainer": {
- "summary": "Response if user is a team maintainer",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "maintainer",
- "state": "active"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "if user has no team membership"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "put": {
- "summary": "Add or update team membership for a user",
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "role": {
- "type": "string",
- "description": "The role that this user should have in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member"
- }
- }
- },
- "examples": {
- "default": {
- "summary": "Add or update team membership for an organization member",
- "value": {
- "role": "maintainer"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Membership",
- "description": "Team Membership",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "role": {
- "description": "The role of the user in the team.",
- "enum": [
- "member",
- "maintainer"
- ],
- "default": "member",
- "example": "member",
- "type": "string"
- },
- "state": {
- "description": "The state of the user's membership in the team.",
- "type": "string",
- "enum": [
- "active",
- "pending"
- ]
- }
- },
- "required": [
- "role",
- "state",
- "url"
- ]
- },
- "examples": {
- "response-if-users-membership-with-team-is-now-pending": {
- "summary": "Response if user's membership with team is now pending",
- "value": {
- "url": "https://api.github.com/teams/1/memberships/octocat",
- "role": "member",
- "state": "pending"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- },
- "422": {
- "description": "Unprocessable Entity if you attempt to add an organization to a team"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- },
- "delete": {
- "summary": "Remove team membership for a user",
- "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/remove-membership-for-user-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if team synchronization is set up"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "members"
- }
- }
- },
- "/orgs/{org}/teams/{team_slug}/projects": {
- "get": {
- "summary": "List team projects",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-projects-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Project",
- "description": "A team's access to a project.",
- "type": "object",
- "properties": {
- "owner_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "html_url": {
- "type": "string"
- },
- "columns_url": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "node_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "body": {
- "type": "string",
- "nullable": true
- },
- "number": {
- "type": "integer"
- },
- "state": {
- "type": "string"
- },
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "created_at": {
- "type": "string"
- },
- "updated_at": {
- "type": "string"
- },
- "organization_permission": {
- "description": "The organization permission for this project. Only present when owner is an organization.",
- "type": "string"
- },
- "private": {
- "description": "Whether the project is private or not. Only present when owner is an organization.",
- "type": "boolean"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "read": {
- "type": "boolean"
- },
- "write": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "read",
- "write",
- "admin"
- ]
- }
- },
- "required": [
- "owner_url",
- "url",
- "html_url",
- "columns_url",
- "id",
- "node_id",
- "name",
- "body",
- "number",
- "state",
- "creator",
- "created_at",
- "updated_at",
- "permissions"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "owner_url": "https://api.github.com/orgs/octocat",
- "url": "https://api.github.com/projects/1002605",
- "html_url": "https://github.com/orgs/api-playground/projects/1",
- "columns_url": "https://api.github.com/projects/1002605/columns",
- "id": 1002605,
- "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year.",
- "number": 1,
- "state": "open",
- "creator": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "created_at": "2011-04-11T20:09:31Z",
- "updated_at": "2014-03-04T18:58:10Z",
- "organization_permission": "write",
- "private": false,
- "permissions": {
- "read": true,
- "write": true,
- "admin": false
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- }
- },
- "/orgs/{org}/teams/{team_slug}/projects/{project_id}": {
- "get": {
- "summary": "Check team permissions for a project",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/check-permissions-for-project-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "project_id",
- "description": "The unique identifier of the project.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Project",
- "description": "A team's access to a project.",
- "type": "object",
- "properties": {
- "owner_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "html_url": {
- "type": "string"
- },
- "columns_url": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "node_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "body": {
- "type": "string",
- "nullable": true
- },
- "number": {
- "type": "integer"
- },
- "state": {
- "type": "string"
- },
- "creator": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ]
- },
- "created_at": {
- "type": "string"
- },
- "updated_at": {
- "type": "string"
- },
- "organization_permission": {
- "description": "The organization permission for this project. Only present when owner is an organization.",
- "type": "string"
- },
- "private": {
- "description": "Whether the project is private or not. Only present when owner is an organization.",
- "type": "boolean"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "read": {
- "type": "boolean"
- },
- "write": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "read",
- "write",
- "admin"
- ]
- }
- },
- "required": [
- "owner_url",
- "url",
- "html_url",
- "columns_url",
- "id",
- "node_id",
- "name",
- "body",
- "number",
- "state",
- "creator",
- "created_at",
- "updated_at",
- "permissions"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "owner_url": "https://api.github.com/orgs/octocat",
- "url": "https://api.github.com/projects/1002605",
- "html_url": "https://github.com/orgs/api-playground/projects/1",
- "columns_url": "https://api.github.com/projects/1002605/columns",
- "id": 1002605,
- "node_id": "MDc6UHJvamVjdDEwMDI2MDU=",
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year.",
- "number": 1,
- "state": "open",
- "creator": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "created_at": "2011-04-11T20:09:31Z",
- "updated_at": "2014-03-04T18:58:10Z",
- "organization_permission": "write",
- "private": false,
- "permissions": {
- "read": true,
- "write": true,
- "admin": false
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Not Found if project is not managed by this team"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- },
- "put": {
- "summary": "Add or update team project permissions",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/add-or-update-project-permissions-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "project_id",
- "description": "The unique identifier of the project.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "permission": {
- "type": "string",
- "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"",
- "enum": [
- "read",
- "write",
- "admin"
- ]
- }
- },
- "nullable": true
- },
- "examples": {
- "default": {
- "summary": "Updates the permissions for the team to write for the project",
- "value": {
- "permission": "write"
- }
- }
- }
- }
- }
- },
- "responses": {
- "204": {
- "description": "Response"
- },
- "403": {
- "description": "Forbidden if the project is not owned by the organization",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- },
- "examples": {
- "response-if-the-project-is-not-owned-by-the-organization": {
- "value": {
- "message": "Must have admin rights to Repository.",
- "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Remove a project from a team",
- "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/remove-project-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "project_id",
- "description": "The unique identifier of the project.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "category": "teams",
- "subcategory": "teams",
- "deprecationDate": "2024-05-23",
- "removalDate": "2025-04-01"
- },
- "deprecated": true
- }
- },
- "/orgs/{org}/teams/{team_slug}/repos": {
- "get": {
- "summary": "List team repositories",
- "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-repos-in-org",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories"
- },
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "team_slug",
- "description": "The slug of the team name.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Minimal Repository",
- "description": "Minimal Repository",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1296269
- },
- "node_id": {
- "type": "string",
- "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
- },
- "name": {
- "type": "string",
- "example": "Hello-World"
- },
- "full_name": {
- "type": "string",
- "example": "octocat/Hello-World"
- },
- "owner": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
+ "email": {
+ "nullable": true,
"type": "string"
},
"login": {
@@ -467260,2382 +465607,682 @@
"content": {
"application/json": {
"schema": {
- "title": "Full Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "example": 42,
- "type": "integer"
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "example": "https://api.github.com/organizations/1/team/1",
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "name": {
- "description": "Name of the team",
- "example": "Developers",
- "type": "string"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "description": {
- "type": "string",
- "example": "A great team.",
- "nullable": true
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "enum": [
- "closed",
- "secret"
- ],
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "enum": [
- "notifications_enabled",
- "notifications_disabled"
- ],
- "example": "notifications_enabled"
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "example": "push",
- "type": "string"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "parent": {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VGVhbTE="
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/organizations/1/team/1/members{/member}"
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "example": "Justice League"
- },
- "description": {
- "description": "Description of the team",
- "type": "string",
- "nullable": true,
- "example": "A great team."
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "example": "admin"
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "example": "closed"
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "example": "notifications_enabled"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/rails/teams/core"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/1/repos"
- },
- "slug": {
- "type": "string",
- "example": "justice-league"
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "example": "uid=example,ou=users,dc=github,dc=com",
- "type": "string"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type"
- ],
- "nullable": true
- },
- "members_count": {
- "type": "integer",
- "example": 3
- },
- "repos_count": {
- "type": "integer",
- "example": 10
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-07-14T16:53:42Z"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2017-08-17T12:37:15Z"
- },
- "organization": {
- "title": "Team Organization",
- "description": "Team Organization",
- "type": "object",
- "properties": {
- "login": {
- "type": "string",
- "example": "github"
- },
- "id": {
- "type": "integer",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDEyOk9yZ2FuaXphdGlvbjE="
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/repos"
- },
- "events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/orgs/github/events"
- },
- "hooks_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/hooks"
- },
- "issues_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/issues"
- },
- "members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/members{/member}"
- },
- "public_members_url": {
- "type": "string",
- "example": "https://api.github.com/orgs/github/public_members{/member}"
- },
- "avatar_url": {
- "type": "string",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "description": {
- "type": "string",
- "example": "A great organization",
- "nullable": true
- },
- "name": {
- "type": "string",
- "example": "github"
- },
- "company": {
- "type": "string",
- "example": "GitHub"
- },
- "blog": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/blog"
- },
- "location": {
- "type": "string",
- "example": "San Francisco"
- },
- "email": {
- "type": "string",
- "format": "email",
- "example": "octocat@github.com"
- },
- "twitter_username": {
- "type": "string",
- "example": "github",
- "nullable": true
- },
- "is_verified": {
- "type": "boolean",
- "example": true
- },
- "has_organization_projects": {
- "type": "boolean",
- "example": true
- },
- "has_repository_projects": {
- "type": "boolean",
- "example": true
- },
- "public_repos": {
- "type": "integer",
- "example": 2
- },
- "public_gists": {
- "type": "integer",
- "example": 1
- },
- "followers": {
- "type": "integer",
- "example": 20
- },
- "following": {
- "type": "integer",
- "example": 0
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2008-01-14T04:33:35Z"
- },
- "type": {
- "type": "string",
- "example": "Organization"
- },
- "total_private_repos": {
- "type": "integer",
- "example": 100
- },
- "owned_private_repos": {
- "type": "integer",
- "example": 100
- },
- "private_gists": {
- "type": "integer",
- "example": 81,
- "nullable": true
- },
- "disk_usage": {
- "type": "integer",
- "example": 10000,
- "nullable": true
- },
- "collaborators": {
- "type": "integer",
- "example": 8,
- "nullable": true
- },
- "billing_email": {
- "type": "string",
- "format": "email",
- "example": "org@example.com",
- "nullable": true
- },
- "plan": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "space": {
- "type": "integer"
- },
- "private_repos": {
- "type": "integer"
- },
- "filled_seats": {
- "type": "integer"
- },
- "seats": {
- "type": "integer"
- }
- },
- "required": [
- "name",
- "space",
- "private_repos"
- ]
- },
- "default_repository_permission": {
- "type": "string",
- "nullable": true
- },
- "members_can_create_repositories": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "two_factor_requirement_enabled": {
- "type": "boolean",
- "example": true,
- "nullable": true
- },
- "members_allowed_repository_creation_type": {
- "type": "string",
- "example": "all"
- },
- "members_can_create_public_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_internal_repositories": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_public_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_create_private_pages": {
- "type": "boolean",
- "example": true
- },
- "members_can_fork_private_repositories": {
- "type": "boolean",
- "example": false,
- "nullable": true
- },
- "web_commit_signoff_required": {
- "type": "boolean",
- "example": false
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- },
- "required": [
- "login",
- "url",
- "id",
- "node_id",
- "repos_url",
- "events_url",
- "hooks_url",
- "issues_url",
- "members_url",
- "public_members_url",
- "avatar_url",
- "description",
- "html_url",
- "has_organization_projects",
- "has_repository_projects",
- "public_repos",
- "public_gists",
- "followers",
- "following",
- "type",
- "created_at",
- "updated_at",
- "archived_at"
- ]
- },
- "ldap_dn": {
- "type": "string",
- "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
- "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
- },
- "type": {
- "description": "The ownership type of the team",
- "type": "string",
- "enum": [
- "enterprise",
- "organization"
- ]
- },
- "organization_id": {
- "type": "integer",
- "description": "Unique identifier of the organization to which this team belongs",
- "example": 37
- },
- "enterprise_id": {
- "type": "integer",
- "description": "Unique identifier of the enterprise to which this team belongs",
- "example": 42
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "type",
- "created_at",
- "updated_at",
- "members_count",
- "repos_count",
- "organization"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "members_count": 3,
- "repos_count": 10,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "organization": {
- "login": "github",
- "id": 1,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
- "url": "https://api.github.com/orgs/github",
- "repos_url": "https://api.github.com/orgs/github/repos",
- "events_url": "https://api.github.com/orgs/github/events",
- "hooks_url": "https://api.github.com/orgs/github/hooks",
- "issues_url": "https://api.github.com/orgs/github/issues",
- "members_url": "https://api.github.com/orgs/github/members{/member}",
- "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "description": "A great organization",
- "name": "github",
- "company": "GitHub",
- "blog": "https://github.com/blog",
- "location": "San Francisco",
- "email": "octocat@github.com",
- "has_organization_projects": true,
- "has_repository_projects": true,
- "public_repos": 2,
- "public_gists": 1,
- "followers": 20,
- "following": 0,
- "html_url": "https://github.com/octocat",
- "created_at": "2008-01-14T04:33:35Z",
- "updated_at": "2017-08-17T12:37:15Z",
- "type": "Organization"
- },
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- },
- "delete": {
- "summary": "Delete a team (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/delete-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Response"
- },
- "404": {
- "description": "Resource not found",
- "content": {
- "application/json": {
- "schema": {
- "title": "Basic Error",
- "description": "Basic Error",
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation failed, or the endpoint has been spammed.",
- "content": {
- "application/json": {
- "schema": {
- "title": "Validation Error",
- "description": "Validation Error",
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- },
- "errors": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "code"
- ],
- "properties": {
- "resource": {
- "type": "string"
- },
- "field": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "index": {
- "type": "integer"
- },
- "value": {
- "oneOf": [
- {
- "type": "string",
- "nullable": true
- },
- {
- "type": "integer",
- "nullable": true
- },
- {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- ]
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "teams"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions": {
- "get": {
- "summary": "List discussions (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/list-discussions-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "asc",
- "desc"
- ],
- "default": "desc"
- }
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- }
- },
- "examples": {
- "default": {
- "value": [
- {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- ]
- }
- }
- }
- },
- "headers": {
- "Link": {
- "example": "; rel=\"next\", ; rel=\"last\"",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "post": {
- "summary": "Create a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/create-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion-legacy"
- },
- "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": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
- },
- "node_id": {
- "type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
- },
- "followers_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
- },
- "following_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
- },
- "gists_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
- },
- "starred_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
- },
- "subscriptions_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
- },
- "organizations_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
- },
- "repos_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
- },
- "events_url": {
- "type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
- },
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
- },
- "type": {
- "type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
- },
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
- },
- "user_view_type": {
- "type": "string",
- "example": "public"
- }
- },
- "required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
- "id",
- "node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
+ "id": {
+ "description": "Unique identifier of the team",
+ "example": 42,
+ "type": "integer"
},
- "created_at": {
+ "node_id": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "example": "MDQ6VGVhbTE="
},
- "last_edited_at": {
+ "url": {
+ "description": "URL for the team",
+ "example": "https://api.github.com/organizations/1/team/1",
"type": "string",
- "format": "date-time",
- "nullable": true
+ "format": "uri"
},
"html_url": {
"type": "string",
"format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
+ "name": {
+ "description": "Name of the team",
+ "example": "Developers",
+ "type": "string"
},
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
+ "slug": {
+ "type": "string",
+ "example": "justice-league"
},
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
+ "description": {
+ "type": "string",
+ "example": "A great team.",
+ "nullable": true
},
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "enum": [
+ "closed",
+ "secret"
+ ],
+ "example": "closed"
},
- "team_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
+ "enum": [
+ "notifications_enabled",
+ "notifications_disabled"
+ ],
+ "example": "notifications_enabled"
},
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "example": "push",
"type": "string"
},
- "updated_at": {
+ "members_url": {
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
- },
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "triggersNotification": true,
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- }
- },
- "/teams/{team_id}/discussions/{discussion_number}": {
- "get": {
- "summary": "Get a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/get-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
- },
- "email": {
- "nullable": true,
- "type": "string"
- },
- "login": {
- "type": "string",
- "example": "octocat"
- },
+ "example": "https://api.github.com/organizations/1/team/1/repos"
+ },
+ "parent": {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
"id": {
+ "description": "Unique identifier of the team",
"type": "integer",
- "format": "int64",
"example": 1
},
"node_id": {
"type": "string",
- "example": "MDQ6VXNlcjE="
- },
- "avatar_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/images/error/octocat_happy.gif"
- },
- "gravatar_id": {
- "type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
- "nullable": true
+ "example": "MDQ6VGVhbTE="
},
"url": {
+ "description": "URL for the team",
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "https://api.github.com/organizations/1/team/1"
},
- "html_url": {
+ "members_url": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "https://api.github.com/organizations/1/team/1/members{/member}"
},
- "followers_url": {
+ "name": {
+ "description": "Name of the team",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "Justice League"
},
- "following_url": {
+ "description": {
+ "description": "Description of the team",
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "nullable": true,
+ "example": "A great team."
},
- "gists_url": {
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "example": "admin"
},
- "starred_url": {
+ "privacy": {
+ "description": "The level of privacy this team should have",
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "closed"
},
- "subscriptions_url": {
+ "notification_setting": {
+ "description": "The notification setting the team has set",
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "notifications_enabled"
},
- "organizations_url": {
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "example": "https://github.com/orgs/rails/teams/core"
},
- "repos_url": {
+ "repositories_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "https://api.github.com/organizations/1/team/1/repos"
},
- "events_url": {
+ "slug": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "example": "justice-league"
},
- "received_events_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "example": "uid=example,ou=users,dc=github,dc=com",
+ "type": "string"
},
"type": {
+ "description": "The ownership type of the team",
"type": "string",
- "example": "User"
- },
- "site_admin": {
- "type": "boolean"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "starred_at": {
- "type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "user_view_type": {
- "type": "string",
- "example": "public"
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
- "repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
- "type",
- "url"
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type"
],
"nullable": true
},
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
+ "members_count": {
+ "type": "integer",
+ "example": 3
},
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
+ "repos_count": {
+ "type": "integer",
+ "example": 10
},
"created_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
- },
- "team_url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "example": "2017-07-14T16:53:42Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "example": "2017-08-17T12:37:15Z"
},
- "reactions": {
- "title": "Reaction Rollup",
+ "organization": {
+ "title": "Team Organization",
+ "description": "Team Organization",
"type": "object",
"properties": {
- "url": {
+ "login": {
"type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
+ "example": "github"
},
- "confused": {
- "type": "integer"
+ "id": {
+ "type": "integer",
+ "example": 1
},
- "heart": {
- "type": "integer"
+ "node_id": {
+ "type": "string",
+ "example": "MDEyOk9yZ2FuaXphdGlvbjE="
},
- "hooray": {
- "type": "integer"
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github"
},
- "eyes": {
- "type": "integer"
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/repos"
},
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
- }
- },
- "required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
- "node_id",
- "number",
- "team_url",
- "title",
- "updated_at",
- "url"
- ]
- },
- "examples": {
- "default": {
- "value": {
- "author": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjE=",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": null,
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Our first team post",
- "updated_at": "2018-01-25T18:56:31Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
- }
- }
- }
- }
- }
- }
- }
- },
- "x-github": {
- "githubCloudOnly": false,
- "enabledForGitHubApps": true,
- "removalDate": "2021-02-01",
- "deprecationDate": "2020-01-21",
- "category": "teams",
- "subcategory": "discussions"
- },
- "deprecated": true
- },
- "patch": {
- "summary": "Update a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
- "tags": [
- "teams"
- ],
- "operationId": "teams/update-discussion-legacy",
- "externalDocs": {
- "description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy"
- },
- "parameters": [
- {
- "name": "team_id",
- "description": "The unique identifier of the team.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The discussion post's title."
- },
- "body": {
- "type": "string",
- "description": "The discussion post's body text."
- }
- }
- },
- "examples": {
- "default": {
- "value": {
- "title": "Welcome to our first team post"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Team Discussion",
- "description": "A team discussion is a persistent record of a free-form conversation within a team.",
- "type": "object",
- "properties": {
- "author": {
- "title": "Simple User",
- "description": "A GitHub user.",
- "type": "object",
- "properties": {
- "name": {
- "nullable": true,
- "type": "string"
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "example": "https://api.github.com/orgs/github/events"
},
- "email": {
- "nullable": true,
- "type": "string"
+ "hooks_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/hooks"
},
- "login": {
+ "issues_url": {
"type": "string",
- "example": "octocat"
+ "example": "https://api.github.com/orgs/github/issues"
},
- "id": {
- "type": "integer",
- "format": "int64",
- "example": 1
+ "members_url": {
+ "type": "string",
+ "example": "https://api.github.com/orgs/github/members{/member}"
},
- "node_id": {
+ "public_members_url": {
"type": "string",
- "example": "MDQ6VXNlcjE="
+ "example": "https://api.github.com/orgs/github/public_members{/member}"
},
"avatar_url": {
"type": "string",
- "format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
- "gravatar_id": {
+ "description": {
"type": "string",
- "example": "41d064eb2195891e12d0413f63227ea7",
+ "example": "A great organization",
"nullable": true
},
- "url": {
+ "name": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat"
+ "example": "github"
},
- "html_url": {
+ "company": {
"type": "string",
- "format": "uri",
- "example": "https://github.com/octocat"
+ "example": "GitHub"
},
- "followers_url": {
+ "blog": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/followers"
+ "example": "https://github.com/blog"
},
- "following_url": {
+ "location": {
"type": "string",
- "example": "https://api.github.com/users/octocat/following{/other_user}"
+ "example": "San Francisco"
},
- "gists_url": {
+ "email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+ "format": "email",
+ "example": "octocat@github.com"
},
- "starred_url": {
+ "twitter_username": {
"type": "string",
- "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ "example": "github",
+ "nullable": true
},
- "subscriptions_url": {
+ "is_verified": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_organization_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "has_repository_projects": {
+ "type": "boolean",
+ "example": true
+ },
+ "public_repos": {
+ "type": "integer",
+ "example": 2
+ },
+ "public_gists": {
+ "type": "integer",
+ "example": 1
+ },
+ "followers": {
+ "type": "integer",
+ "example": 20
+ },
+ "following": {
+ "type": "integer",
+ "example": 0
+ },
+ "html_url": {
"type": "string",
"format": "uri",
- "example": "https://api.github.com/users/octocat/subscriptions"
+ "example": "https://github.com/octocat"
},
- "organizations_url": {
+ "created_at": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/orgs"
+ "format": "date-time",
+ "example": "2008-01-14T04:33:35Z"
},
- "repos_url": {
+ "type": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/repos"
+ "example": "Organization"
},
- "events_url": {
+ "total_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "owned_private_repos": {
+ "type": "integer",
+ "example": 100
+ },
+ "private_gists": {
+ "type": "integer",
+ "example": 81,
+ "nullable": true
+ },
+ "disk_usage": {
+ "type": "integer",
+ "example": 10000,
+ "nullable": true
+ },
+ "collaborators": {
+ "type": "integer",
+ "example": 8,
+ "nullable": true
+ },
+ "billing_email": {
"type": "string",
- "example": "https://api.github.com/users/octocat/events{/privacy}"
+ "format": "email",
+ "example": "org@example.com",
+ "nullable": true
},
- "received_events_url": {
+ "plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "space": {
+ "type": "integer"
+ },
+ "private_repos": {
+ "type": "integer"
+ },
+ "filled_seats": {
+ "type": "integer"
+ },
+ "seats": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "name",
+ "space",
+ "private_repos"
+ ]
+ },
+ "default_repository_permission": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/users/octocat/received_events"
+ "nullable": true
},
- "type": {
+ "members_can_create_repositories": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "two_factor_requirement_enabled": {
+ "type": "boolean",
+ "example": true,
+ "nullable": true
+ },
+ "members_allowed_repository_creation_type": {
"type": "string",
- "example": "User"
+ "example": "all"
},
- "site_admin": {
- "type": "boolean"
+ "members_can_create_public_repositories": {
+ "type": "boolean",
+ "example": true
},
- "starred_at": {
+ "members_can_create_private_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_internal_repositories": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_public_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_create_private_pages": {
+ "type": "boolean",
+ "example": true
+ },
+ "members_can_fork_private_repositories": {
+ "type": "boolean",
+ "example": false,
+ "nullable": true
+ },
+ "web_commit_signoff_required": {
+ "type": "boolean",
+ "example": false
+ },
+ "updated_at": {
"type": "string",
- "example": "\"2020-07-09T00:17:55Z\""
+ "format": "date-time"
},
- "user_view_type": {
+ "archived_at": {
"type": "string",
- "example": "public"
+ "format": "date-time",
+ "nullable": true
}
},
"required": [
- "avatar_url",
- "events_url",
- "followers_url",
- "following_url",
- "gists_url",
- "gravatar_id",
- "html_url",
+ "login",
+ "url",
"id",
"node_id",
- "login",
- "organizations_url",
- "received_events_url",
"repos_url",
- "site_admin",
- "starred_url",
- "subscriptions_url",
+ "events_url",
+ "hooks_url",
+ "issues_url",
+ "members_url",
+ "public_members_url",
+ "avatar_url",
+ "description",
+ "html_url",
+ "has_organization_projects",
+ "has_repository_projects",
+ "public_repos",
+ "public_gists",
+ "followers",
+ "following",
"type",
- "url"
- ],
- "nullable": true
- },
- "body": {
- "description": "The main text of the discussion.",
- "example": "Please suggest improvements to our workflow in comments.",
- "type": "string"
- },
- "body_html": {
- "type": "string",
- "example": "Hi! This is an area for us to collaborate as a team
"
- },
- "body_version": {
- "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.",
- "example": "0307116bbf7ced493b8d8a346c650b71",
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
- },
- "last_edited_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "example": "https://github.com/orgs/github/teams/justice-league/discussions/1"
- },
- "node_id": {
- "type": "string",
- "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ=="
- },
- "number": {
- "description": "The unique sequence number of a team discussion.",
- "example": 42,
- "type": "integer"
- },
- "pinned": {
- "description": "Whether or not this discussion should be pinned for easy retrieval.",
- "example": true,
- "type": "boolean"
- },
- "private": {
- "description": "Whether or not this discussion should be restricted to team members and organization owners.",
- "example": true,
- "type": "boolean"
+ "created_at",
+ "updated_at",
+ "archived_at"
+ ]
},
- "team_url": {
+ "ldap_dn": {
"type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027"
- },
- "title": {
- "description": "The title of the discussion.",
- "example": "How can we improve our workflow?",
- "type": "string"
+ "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
+ "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
},
- "updated_at": {
+ "type": {
+ "description": "The ownership type of the team",
"type": "string",
- "format": "date-time",
- "example": "2018-01-25T18:56:31Z"
+ "enum": [
+ "enterprise",
+ "organization"
+ ]
},
- "url": {
- "type": "string",
- "format": "uri",
- "example": "https://api.github.com/organizations/1/team/2343027/discussions/1"
+ "organization_id": {
+ "type": "integer",
+ "description": "Unique identifier of the organization to which this team belongs",
+ "example": 37
},
- "reactions": {
- "title": "Reaction Rollup",
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "format": "uri"
- },
- "total_count": {
- "type": "integer"
- },
- "+1": {
- "type": "integer"
- },
- "-1": {
- "type": "integer"
- },
- "laugh": {
- "type": "integer"
- },
- "confused": {
- "type": "integer"
- },
- "heart": {
- "type": "integer"
- },
- "hooray": {
- "type": "integer"
- },
- "eyes": {
- "type": "integer"
- },
- "rocket": {
- "type": "integer"
- }
- },
- "required": [
- "url",
- "total_count",
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "eyes",
- "rocket"
- ]
+ "enterprise_id": {
+ "type": "integer",
+ "description": "Unique identifier of the enterprise to which this team belongs",
+ "example": 42
}
},
"required": [
- "author",
- "body",
- "body_html",
- "body_version",
- "created_at",
- "last_edited_at",
- "html_url",
- "pinned",
- "private",
+ "id",
"node_id",
- "number",
- "team_url",
- "title",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "type",
+ "created_at",
"updated_at",
- "url"
+ "members_count",
+ "repos_count",
+ "organization"
]
},
"examples": {
"default": {
"value": {
- "author": {
- "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "members_count": 3,
+ "repos_count": 10,
+ "created_at": "2017-07-14T16:53:42Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "organization": {
+ "login": "github",
"id": 1,
- "node_id": "MDQ6VXNlcjE=",
+ "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
+ "url": "https://api.github.com/orgs/github",
+ "repos_url": "https://api.github.com/orgs/github/repos",
+ "events_url": "https://api.github.com/orgs/github/events",
+ "hooks_url": "https://api.github.com/orgs/github/hooks",
+ "issues_url": "https://api.github.com/orgs/github/issues",
+ "members_url": "https://api.github.com/orgs/github/members{/member}",
+ "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
+ "description": "A great organization",
+ "name": "github",
+ "company": "GitHub",
+ "blog": "https://github.com/blog",
+ "location": "San Francisco",
+ "email": "octocat@github.com",
+ "has_organization_projects": true,
+ "has_repository_projects": true,
+ "public_repos": 2,
+ "public_gists": 1,
+ "followers": 20,
+ "following": 0,
"html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
+ "created_at": "2008-01-14T04:33:35Z",
+ "updated_at": "2017-08-17T12:37:15Z",
+ "type": "Organization"
},
- "body": "Hi! This is an area for us to collaborate as a team.",
- "body_html": "Hi! This is an area for us to collaborate as a team
",
- "body_version": "0d495416a700fb06133c612575d92bfb",
- "created_at": "2018-01-25T18:56:31Z",
- "last_edited_at": "2018-01-26T18:22:20Z",
- "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1",
- "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==",
- "number": 1,
- "pinned": false,
- "private": false,
- "team_url": "https://api.github.com/teams/2343027",
- "title": "Welcome to our first team post",
- "updated_at": "2018-01-26T18:22:20Z",
- "url": "https://api.github.com/teams/2343027/discussions/1",
- "reactions": {
- "url": "https://api.github.com/teams/2343027/discussions/1/reactions",
- "total_count": 5,
- "+1": 3,
- "-1": 1,
- "laugh": 0,
- "confused": 0,
- "heart": 1,
- "hooray": 0,
- "eyes": 1,
- "rocket": 1
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
}
}
}
}
}
}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -469644,20 +466291,20 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
},
"delete": {
- "summary": "Delete a discussion (Legacy)",
- "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.",
+ "summary": "Delete a team (Legacy)",
+ "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.",
"tags": [
"teams"
],
- "operationId": "teams/delete-discussion-legacy",
+ "operationId": "teams/delete-legacy",
"externalDocs": {
"description": "API method documentation",
- "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion-legacy"
+ "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team-legacy"
},
"parameters": [
{
@@ -469668,20 +466315,106 @@
"schema": {
"type": "integer"
}
- },
- {
- "name": "discussion_number",
- "description": "The number that identifies the discussion.",
- "in": "path",
- "required": true,
- "schema": {
- "type": "integer"
- }
}
],
"responses": {
"204": {
"description": "Response"
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Validation Error",
+ "description": "Validation Error",
+ "type": "object",
+ "required": [
+ "message",
+ "documentation_url"
+ ],
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "errors": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "code"
+ ],
+ "properties": {
+ "resource": {
+ "type": "string"
+ },
+ "field": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "index": {
+ "type": "integer"
+ },
+ "value": {
+ "oneOf": [
+ {
+ "type": "string",
+ "nullable": true
+ },
+ {
+ "type": "integer",
+ "nullable": true
+ },
+ {
+ "type": "array",
+ "nullable": true,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -469690,7 +466423,7 @@
"removalDate": "2021-02-01",
"deprecationDate": "2020-01-21",
"category": "teams",
- "subcategory": "discussions"
+ "subcategory": "teams"
},
"deprecated": true
}
diff --git a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
index d82650cc6..845a460c6 100644
--- a/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
+++ b/descriptions/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml
@@ -4479,7 +4479,7 @@ paths:
application/json:
schema: *24
application/scim+json:
- schema: &548
+ schema: &545
title: Scim Error
description: Scim Error
type: object
@@ -12365,7 +12365,7 @@ paths:
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
- instances_url: &379
+ instances_url: &376
type: string
description: The REST API URL for fetching the list of instances
for an alert.
@@ -12400,7 +12400,7 @@ paths:
format: date-time
readOnly: true
nullable: true
- dismissed_reason: &380
+ dismissed_reason: &377
type: string
description: "**Required when the state is dismissed.** The
reason for dismissing or closing the alert."
@@ -12409,13 +12409,13 @@ paths:
- false positive
- won't fix
- used in tests
- dismissed_comment: &381
+ dismissed_comment: &378
type: string
description: The dismissal comment associated with the dismissal
of the alert.
nullable: true
maxLength: 280
- rule: &382
+ rule: &379
type: object
properties:
id:
@@ -12454,7 +12454,7 @@ paths:
description: A set of tags applicable for the rule.
items:
type: string
- tool: &383
+ tool: &380
type: object
properties:
name: *90
@@ -12464,26 +12464,26 @@ paths:
description: The version of the tool used to generate the
code scanning analysis.
guid: *91
- most_recent_instance: &384
+ most_recent_instance: &381
type: object
properties:
- ref: &377
+ ref: &374
type: string
description: |-
The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.
- analysis_key: &389
+ analysis_key: &386
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: &390
+ environment: &387
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: &391
+ category: &388
type: string
description: Identifies the configuration under which the
analysis was executed. Used to distinguish between multiple
@@ -12497,7 +12497,7 @@ paths:
properties:
text:
type: string
- location: &392
+ location: &389
type: object
description: Describe a region within a file for the alert.
properties:
@@ -12518,7 +12518,7 @@ paths:
description: |-
Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.
- items: &393
+ items: &390
type: string
description: A classification of the file. For example
to identify it as generated.
@@ -13300,7 +13300,7 @@ paths:
Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
schema:
type: string
- - &415
+ - &412
name: has
in: query
description: |-
@@ -13423,7 +13423,7 @@ paths:
enum:
- development
- runtime
- security_advisory: &416
+ security_advisory: &413
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
@@ -13654,14 +13654,14 @@ paths:
nullable: true
maxLength: 280
fixed_at: *102
- auto_dismissed_at: &417
+ auto_dismissed_at: &414
type: string
description: 'The time that the alert was auto-dismissed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable: true
- dismissal_request: &418
+ dismissal_request: &415
title: Dependabot alert dismissal request
description: Information about an active dismissal request for
this Dependabot alert.
@@ -14137,14 +14137,14 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: &539
+ state: &536
description: Sets the state of the secret scanning alert. You
must provide `resolution` when you set the state to `resolved`.
type: string
enum:
- open
- resolved
- resolution: &540
+ resolution: &537
type: string
description: "**Required when the `state` is `resolved`.** The
reason for resolving the alert."
@@ -14730,7 +14730,7 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: &463
+ properties: &460
id:
type: integer
format: int64
@@ -14993,7 +14993,7 @@ paths:
timeline_url:
type: string
format: uri
- type: &575
+ type: &572
title: Issue Type
description: The type of issue.
type: object
@@ -15107,7 +15107,7 @@ paths:
- hooray
- eyes
- rocket
- sub_issues_summary: &572
+ sub_issues_summary: &569
title: Sub-issues Summary
type: object
properties:
@@ -15127,7 +15127,7 @@ paths:
type: string
format: uri
nullable: true
- issue_dependencies_summary: &573
+ issue_dependencies_summary: &570
title: Issue Dependencies Summary
type: object
properties:
@@ -15146,7 +15146,7 @@ paths:
- total_blocking
issue_field_values:
type: array
- items: &574
+ items: &571
title: Issue Field Value
description: A value assigned to an issue field
type: object
@@ -15207,7 +15207,7 @@ paths:
- node_id
- data_type
- value
- required: &464
+ required: &461
- assignee
- closed_at
- comments
@@ -15291,7 +15291,7 @@ paths:
action:
type: string
issue: *109
- comment: &459
+ comment: &456
title: Issue Comment
description: Comments provide a way for people to collaborate
on an issue.
@@ -15950,7 +15950,7 @@ paths:
- review_comment
- self
author_association: *110
- auto_merge: &407
+ auto_merge: &404
title: Auto merge
description: The status of auto merging a pull request.
type: object
@@ -16414,7 +16414,7 @@ paths:
type: string
release:
allOf:
- - &517
+ - &514
title: Release
description: A release.
type: object
@@ -16485,7 +16485,7 @@ paths:
author: *19
assets:
type: array
- items: &518
+ items: &515
title: Release Asset
description: Data related to a release.
type: object
@@ -17065,7 +17065,7 @@ paths:
url:
type: string
format: uri
- user: &588
+ user: &583
title: Public User
description: Public User
type: object
@@ -21685,14 +21685,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- - &299
+ - &296
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
- - &300
+ - &297
name: repo
description: The name of the repository without the `.git` extension. The
name is not case sensitive.
@@ -21764,7 +21764,7 @@ paths:
'404': *26
'403': *43
'304': *42
- '301': &311
+ '301': &308
description: Moved permanently
content:
application/json:
@@ -21786,7 +21786,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user
parameters:
- - &491
+ - &488
name: all
description: If `true`, show notifications marked as read.
in: query
@@ -21794,7 +21794,7 @@ paths:
schema:
type: boolean
default: false
- - &492
+ - &489
name: participating
description: If `true`, only shows notifications in which the user is directly
participating or mentioned.
@@ -21804,7 +21804,7 @@ paths:
type: boolean
default: false
- *119
- - &493
+ - &490
name: before
description: 'Only show notifications updated before the given time. This
is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format:
@@ -22248,7 +22248,7 @@ paths:
- url
- subscription_url
examples:
- default: &494
+ default: &491
value:
- id: '1'
repository:
@@ -22794,7 +22794,7 @@ paths:
type: array
items: *70
examples:
- default: &597
+ default: &592
value:
- login: github
id: 1
@@ -23685,7 +23685,7 @@ paths:
type: integer
repository_cache_usages:
type: array
- items: &316
+ items: &313
title: Actions Cache Usage by repository
description: GitHub Actions Cache Usage by repository.
type: object
@@ -23936,7 +23936,7 @@ paths:
type: array
items: *84
examples:
- default: &594
+ default: &589
value:
total_count: 1
repositories:
@@ -25737,7 +25737,7 @@ paths:
description: Response
content:
application/json:
- schema: &338
+ schema: &335
title: ActionsPublicKey
description: The public key used for setting Actions Secrets.
type: object
@@ -25766,7 +25766,7 @@ paths:
- key_id
- key
examples:
- default: &339
+ default: &336
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -26179,7 +26179,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-organization-variables
parameters:
- *140
- - &323
+ - &320
name: per_page
description: The number of results per page (max 30). For more information,
see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
@@ -26828,7 +26828,7 @@ paths:
be returned.
in: query
required: false
- schema: &378
+ schema: &375
type: string
description: Severity of a code scanning alert.
enum:
@@ -27370,7 +27370,7 @@ paths:
description: Response
content:
application/json:
- schema: &421
+ schema: &418
title: DependabotPublicKey
description: The public key used for setting Dependabot Secrets.
type: object
@@ -27387,7 +27387,7 @@ paths:
- key_id
- key
examples:
- default: &422
+ default: &419
value:
key_id: '012345678912345678'
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -27985,7 +27985,7 @@ paths:
description: Response
content:
application/json:
- schema: &294
+ schema: &291
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
@@ -28066,7 +28066,7 @@ paths:
example: mona_lisa@github.com
type: string
examples:
- default: &295
+ default: &292
value:
group_id: '123'
group_name: Octocat admins
@@ -28121,7 +28121,7 @@ paths:
description: Response
content:
application/json:
- schema: &292
+ schema: &289
title: ExternalGroups
description: A list of external groups available to be connected to
a team
@@ -28158,7 +28158,7 @@ paths:
example: 2019-06-03 22:27:15:000 -700
type: string
examples:
- default: &293
+ default: &290
value:
groups:
- group_id: '123'
@@ -28794,7 +28794,7 @@ paths:
application/json:
schema: *39
examples:
- default: &456
+ default: &453
value:
id: 1
account:
@@ -31482,7 +31482,7 @@ paths:
- nuget
- container
- *140
- - &598
+ - &593
name: visibility
description: |-
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
@@ -31523,7 +31523,7 @@ paths:
default: *225
'403': *43
'401': *41
- '400': &600
+ '400': &595
description: The value of `per_page` multiplied by `page` cannot be greater
than 10000.
x-github:
@@ -33976,7 +33976,7 @@ paths:
description: Response
content:
application/json:
- schema: &310
+ schema: &307
title: Full Repository
description: Full Repository
type: object
@@ -34474,7 +34474,7 @@ paths:
- network_count
- subscribers_count
examples:
- default: &312
+ default: &309
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
@@ -35046,7 +35046,7 @@ paths:
- *140
- *4
- *5
- - &525
+ - &522
name: targets
description: |
A comma-separated list of rule targets to filter by.
@@ -35320,7 +35320,7 @@ paths:
- repository_property
rules:
type: array
- items: &526
+ items: &523
title: Repository Rule
type: object
description: A repository rule.
@@ -36066,7 +36066,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#list-organization-rule-suites
parameters:
- *140
- - &527
+ - &524
name: ref
description: The name of the ref. Cannot contain wildcard characters. When
specified, only rule evaluations triggered for this ref will be returned.
@@ -36079,7 +36079,7 @@ paths:
in: query
schema:
type: string
- - &528
+ - &525
name: time_period
description: |-
The time period to filter by.
@@ -36095,14 +36095,14 @@ paths:
- week
- month
default: day
- - &529
+ - &526
name: actor_name
description: The handle for the GitHub user account to filter on. When specified,
only rule evaluations triggered by this actor will be returned.
in: query
schema:
type: string
- - &530
+ - &527
name: rule_suite_result
description: The rule suite results to filter on. When specified, only suites
with this result will be returned.
@@ -36122,7 +36122,7 @@ paths:
description: Response
content:
application/json:
- schema: &531
+ schema: &528
title: Rule Suites
description: Response
type: array
@@ -36176,7 +36176,7 @@ paths:
whether rules would pass or fail if all rules in the rule
suite were `active`.
examples:
- default: &532
+ default: &529
value:
- id: 21
actor_id: 12
@@ -36220,7 +36220,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#get-an-organization-rule-suite
parameters:
- *140
- - &533
+ - &530
name: rule_suite_id
description: |-
The unique identifier of the rule suite result.
@@ -36236,7 +36236,7 @@ paths:
description: Response
content:
application/json:
- schema: &534
+ schema: &531
title: Rule Suite
description: Response
type: object
@@ -36334,7 +36334,7 @@ paths:
description: The detailed failure message for the rule.
Null if the rule passed.
examples:
- default: &535
+ default: &532
value:
id: 21
actor_id: 12
@@ -36552,7 +36552,7 @@ paths:
- *9
- *5
- *4
- - &537
+ - &534
name: before
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events before this cursor. To
@@ -36562,7 +36562,7 @@ paths:
required: false
schema:
type: string
- - &538
+ - &535
name: after
description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers).
If specified, the query only searches for events after this cursor. To
@@ -36734,7 +36734,7 @@ paths:
application/json:
schema:
type: array
- items: &301
+ items: &298
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -37457,454 +37457,6 @@ paths:
enabledForGitHubApps: true
category: teams
subcategory: teams
- "/orgs/{org}/teams/{team_slug}/discussions":
- get:
- summary: List discussions
- description: |-
- List all discussions on a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions
- parameters:
- - *140
- - *219
- - *9
- - *4
- - *5
- - name: pinned
- in: query
- required: false
- description: Pinned discussions only filter
- schema:
- type: string
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: &289
- title: Team Discussion
- description: A team discussion is a persistent record of a free-form
- conversation within a team.
- type: object
- properties:
- author:
- title: Simple User
- description: A GitHub user.
- type: object
- properties: *17
- required: *18
- nullable: true
- body:
- description: The main text of the discussion.
- example: Please suggest improvements to our workflow in comments.
- type: string
- body_html:
- type: string
- example: "Hi! This is an area for us to collaborate as a
- team
"
- body_version:
- description: The current version of the body content. If provided,
- this update operation will be rejected if the given version
- does not match the latest version on the server.
- example: 0307116bbf7ced493b8d8a346c650b71
- type: string
- created_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- last_edited_at:
- type: string
- format: date-time
- nullable: true
- html_url:
- type: string
- format: uri
- example: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id:
- type: string
- example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number:
- description: The unique sequence number of a team discussion.
- example: 42
- type: integer
- pinned:
- description: Whether or not this discussion should be pinned
- for easy retrieval.
- example: true
- type: boolean
- private:
- description: Whether or not this discussion should be restricted
- to team members and organization owners.
- example: true
- type: boolean
- team_url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027
- title:
- description: The title of the discussion.
- example: How can we improve our workflow?
- type: string
- updated_at:
- type: string
- format: date-time
- example: '2018-01-25T18:56:31Z'
- url:
- type: string
- format: uri
- example: https://api.github.com/organizations/1/team/2343027/discussions/1
- reactions: *111
- required:
- - author
- - body
- - body_html
- - body_version
- - created_at
- - last_edited_at
- - html_url
- - pinned
- - private
- - node_id
- - number
- - team_url
- - title
- - updated_at
- - url
- examples:
- default: &580
- value:
- - author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- 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: *6
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- post:
- summary: Create a discussion
- description: |-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)."
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion
- parameters:
- - *140
- - *219
- 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: *289
- examples:
- default: &290
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at:
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Our first team post
- updated_at: '2018-01-25T18:56:31Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}":
- get:
- summary: Get a discussion
- description: |-
- Get a specific discussion on a team's page.
-
- > [!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}`.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion
- parameters:
- - *140
- - *219
- - &291
- name: discussion_number
- description: The number that identifies the discussion.
- in: path
- required: true
- schema:
- type: integer
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *289
- examples:
- default: *290
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- patch:
- summary: Update a discussion
- description: |-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion
- parameters:
- - *140
- - *219
- - *291
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *289
- examples:
- default: &581
- value:
- author:
- login: octocat
- id: 1
- node_id: MDQ6VXNlcjE=
- avatar_url: https://github.com/images/error/octocat_happy.gif
- gravatar_id: ''
- url: https://api.github.com/users/octocat
- html_url: https://github.com/octocat
- followers_url: https://api.github.com/users/octocat/followers
- following_url: https://api.github.com/users/octocat/following{/other_user}
- gists_url: https://api.github.com/users/octocat/gists{/gist_id}
- starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
- subscriptions_url: https://api.github.com/users/octocat/subscriptions
- organizations_url: https://api.github.com/users/octocat/orgs
- repos_url: https://api.github.com/users/octocat/repos
- events_url: https://api.github.com/users/octocat/events{/privacy}
- received_events_url: https://api.github.com/users/octocat/received_events
- type: User
- site_admin: false
- body: Hi! This is an area for us to collaborate as a team.
- body_html: "Hi! This is an area for us to collaborate as a
- team
"
- body_version: 0d495416a700fb06133c612575d92bfb
- created_at: '2018-01-25T18:56:31Z'
- last_edited_at: '2018-01-26T18:22:20Z'
- html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
- node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
- number: 1
- pinned: false
- private: false
- team_url: https://api.github.com/teams/2343027
- title: Welcome to our first team post
- updated_at: '2018-01-26T18:22:20Z'
- url: https://api.github.com/teams/2343027/discussions/1
- reactions:
- url: https://api.github.com/teams/2343027/discussions/1/reactions
- total_count: 5
- "+1": 3
- "-1": 1
- laugh: 0
- confused: 0
- heart: 1
- hooray: 0
- eyes: 1
- rocket: 1
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
- delete:
- summary: Delete a discussion
- description: |-
- Delete a discussion from a team's page.
-
- > [!NOTE]
- > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-in-org
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion
- parameters:
- - *140
- - *219
- - *291
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- category: teams
- subcategory: discussions
"/orgs/{org}/teams/{team_slug}/external-groups":
get:
summary: List a connection between an external group and a team
@@ -37926,9 +37478,9 @@ paths:
description: Response
content:
application/json:
- schema: *292
+ schema: *289
examples:
- default: *293
+ default: *290
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
@@ -37971,9 +37523,9 @@ paths:
description: Response
content:
application/json:
- schema: *294
+ schema: *291
examples:
- default: *295
+ default: *292
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
@@ -38078,7 +37630,7 @@ paths:
description: Response
content:
application/json:
- schema: &296
+ schema: &293
title: Team Membership
description: Team Membership
type: object
@@ -38105,7 +37657,7 @@ paths:
- state
- url
examples:
- response-if-user-is-a-team-maintainer: &582
+ response-if-user-is-a-team-maintainer: &577
summary: Response if user is a team maintainer
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -38168,9 +37720,9 @@ paths:
description: Response
content:
application/json:
- schema: *296
+ schema: *293
examples:
- response-if-users-membership-with-team-is-now-pending: &583
+ response-if-users-membership-with-team-is-now-pending: &578
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
@@ -38243,7 +37795,7 @@ paths:
application/json:
schema:
type: array
- items: &297
+ items: &294
title: Team Project
description: A team's access to a project.
type: object
@@ -38311,7 +37863,7 @@ paths:
- updated_at
- permissions
examples:
- default: &584
+ default: &579
value:
- owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -38376,7 +37928,7 @@ paths:
parameters:
- *140
- *219
- - &298
+ - &295
name: project_id
description: The unique identifier of the project.
in: path
@@ -38388,9 +37940,9 @@ paths:
description: Response
content:
application/json:
- schema: *297
+ schema: *294
examples:
- default: &585
+ default: &580
value:
owner_url: https://api.github.com/orgs/octocat
url: https://api.github.com/projects/1002605
@@ -38454,7 +38006,7 @@ paths:
parameters:
- *140
- *219
- - *298
+ - *295
requestBody:
required: false
content:
@@ -38522,7 +38074,7 @@ paths:
parameters:
- *140
- *219
- - *298
+ - *295
responses:
'204':
description: Response
@@ -38593,14 +38145,14 @@ paths:
parameters:
- *140
- *219
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Alternative response with repository permissions
content:
application/json:
- schema: &586
+ schema: &581
title: Team Repository
description: A team's access to a repository.
type: object
@@ -39171,8 +38723,8 @@ paths:
parameters:
- *140
- *219
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: false
content:
@@ -39219,8 +38771,8 @@ paths:
parameters:
- *140
- *219
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -39255,9 +38807,9 @@ paths:
application/json:
schema:
type: array
- items: *301
+ items: *298
examples:
- response-if-child-teams-exist: &587
+ response-if-child-teams-exist: &582
value:
- id: 2
node_id: MDQ6VGVhbTI=
@@ -39384,7 +38936,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card
parameters:
- - &302
+ - &299
name: card_id
description: The unique identifier of the card.
in: path
@@ -39396,7 +38948,7 @@ paths:
description: Response
content:
application/json:
- schema: &303
+ schema: &300
title: Project Card
description: Project cards represent a scope of work.
type: object
@@ -39463,7 +39015,7 @@ paths:
- created_at
- updated_at
examples:
- default: &304
+ default: &301
value:
url: https://api.github.com/projects/columns/cards/1478
id: 1478
@@ -39519,7 +39071,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#update-an-existing-project-card
parameters:
- - *302
+ - *299
requestBody:
required: false
content:
@@ -39546,9 +39098,9 @@ paths:
description: Response
content:
application/json:
- schema: *303
+ schema: *300
examples:
- default: *304
+ default: *301
'304': *42
'403': *43
'401': *41
@@ -39575,7 +39127,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card
parameters:
- - *302
+ - *299
responses:
'204':
description: Response
@@ -39619,7 +39171,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card
parameters:
- - *302
+ - *299
requestBody:
required: true
content:
@@ -39730,7 +39282,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column
parameters:
- - &305
+ - &302
name: column_id
description: The unique identifier of the column.
in: path
@@ -39742,7 +39294,7 @@ paths:
description: Response
content:
application/json:
- schema: &306
+ schema: &303
title: Project Column
description: Project columns contain cards of work.
type: object
@@ -39788,7 +39340,7 @@ paths:
- created_at
- updated_at
examples:
- default: &307
+ default: &304
value:
url: https://api.github.com/projects/columns/367
project_url: https://api.github.com/projects/120
@@ -39823,7 +39375,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#update-an-existing-project-column
parameters:
- - *305
+ - *302
requestBody:
required: true
content:
@@ -39847,9 +39399,9 @@ paths:
description: Response
content:
application/json:
- schema: *306
+ schema: *303
examples:
- default: *307
+ default: *304
'304': *42
'403': *43
'401': *41
@@ -39874,7 +39426,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#delete-a-project-column
parameters:
- - *305
+ - *302
responses:
'204':
description: Response
@@ -39903,7 +39455,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#list-project-cards
parameters:
- - *305
+ - *302
- name: archived_state
description: Filters the project cards that are returned by the card's state.
in: query
@@ -39924,7 +39476,7 @@ paths:
application/json:
schema:
type: array
- items: *303
+ items: *300
examples:
default:
value:
@@ -39983,7 +39535,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#create-a-project-card
parameters:
- - *305
+ - *302
requestBody:
required: true
content:
@@ -40023,9 +39575,9 @@ paths:
description: Response
content:
application/json:
- schema: *303
+ schema: *300
examples:
- default: *304
+ default: *301
'304': *42
'403': *43
'401': *41
@@ -40081,7 +39633,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#move-a-project-column
parameters:
- - *305
+ - *302
requestBody:
required: true
content:
@@ -40140,7 +39692,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#get-a-project
parameters:
- - *298
+ - *295
responses:
'200':
description: Response
@@ -40148,7 +39700,7 @@ paths:
application/json:
schema: *242
examples:
- default: &308
+ default: &305
value:
owner_url: https://api.github.com/repos/api-playground/projects-test
url: https://api.github.com/projects/1002604
@@ -40202,7 +39754,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#update-a-project
parameters:
- - *298
+ - *295
requestBody:
required: false
content:
@@ -40250,7 +39802,7 @@ paths:
application/json:
schema: *242
examples:
- default: *308
+ default: *305
'404':
description: Not Found if the authenticated user does not have access to
the project
@@ -40290,7 +39842,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#delete-a-project
parameters:
- - *298
+ - *295
responses:
'204':
description: Delete Success
@@ -40333,7 +39885,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#list-project-collaborators
parameters:
- - *298
+ - *295
- name: affiliation
description: Filters the collaborators by their affiliation. `outside` means
outside collaborators of a project that are not a member of the project's
@@ -40390,7 +39942,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#add-project-collaborator
parameters:
- - *298
+ - *295
- *8
requestBody:
required: false
@@ -40443,7 +39995,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#remove-user-as-a-collaborator
parameters:
- - *298
+ - *295
- *8
responses:
'204':
@@ -40475,7 +40027,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#get-project-permission-for-a-user
parameters:
- - *298
+ - *295
- *8
responses:
'200':
@@ -40549,7 +40101,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#list-project-columns
parameters:
- - *298
+ - *295
- *4
- *5
responses:
@@ -40559,7 +40111,7 @@ paths:
application/json:
schema:
type: array
- items: *306
+ items: *303
examples:
default:
value:
@@ -40597,7 +40149,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#create-a-project-column
parameters:
- - *298
+ - *295
requestBody:
required: true
content:
@@ -40620,7 +40172,7 @@ paths:
description: Response
content:
application/json:
- schema: *306
+ schema: *303
examples:
default:
value:
@@ -40685,7 +40237,7 @@ paths:
resources:
type: object
properties:
- core: &309
+ core: &306
title: Rate Limit
type: object
properties:
@@ -40702,20 +40254,20 @@ paths:
- remaining
- reset
- used
- graphql: *309
- search: *309
- code_search: *309
- source_import: *309
- integration_manifest: *309
- code_scanning_upload: *309
- actions_runner_registration: *309
- scim: *309
- dependency_sbom: *309
- code_scanning_autofix: *309
+ graphql: *306
+ search: *306
+ code_search: *306
+ source_import: *306
+ integration_manifest: *306
+ code_scanning_upload: *306
+ actions_runner_registration: *306
+ scim: *306
+ dependency_sbom: *306
+ code_scanning_autofix: *306
required:
- core
- search
- rate: *309
+ rate: *306
required:
- rate
- resources
@@ -40820,14 +40372,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: *310
+ schema: *307
examples:
default-response:
summary: Default response
@@ -41326,7 +40878,7 @@ paths:
status: disabled
'403': *43
'404': *26
- '301': *311
+ '301': *308
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -41344,8 +40896,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#update-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: false
content:
@@ -41561,10 +41113,10 @@ paths:
description: Response
content:
application/json:
- schema: *310
+ schema: *307
examples:
- default: *312
- '307': &313
+ default: *309
+ '307': &310
description: Temporary Redirect
content:
application/json:
@@ -41609,8 +41161,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -41632,7 +41184,7 @@ paths:
value:
message: Organization members cannot delete repositories.
documentation_url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository
- '307': *313
+ '307': *310
'404': *26
'409': *145
x-github:
@@ -41656,11 +41208,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
- - &330
+ - &327
name: name
description: The name field of an artifact. When specified, only artifacts
with this name will be returned.
@@ -41683,7 +41235,7 @@ paths:
type: integer
artifacts:
type: array
- items: &314
+ items: &311
title: Artifact
description: An artifact
type: object
@@ -41754,7 +41306,7 @@ paths:
- expires_at
- updated_at
examples:
- default: &331
+ default: &328
value:
total_count: 2
artifacts:
@@ -41813,9 +41365,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#get-an-artifact
parameters:
- - *299
- - *300
- - &315
+ - *296
+ - *297
+ - &312
name: artifact_id
description: The unique identifier of the artifact.
in: path
@@ -41827,7 +41379,7 @@ paths:
description: Response
content:
application/json:
- schema: *314
+ schema: *311
examples:
default:
value:
@@ -41864,9 +41416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#delete-an-artifact
parameters:
- - *299
- - *300
- - *315
+ - *296
+ - *297
+ - *312
responses:
'204':
description: Response
@@ -41890,9 +41442,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#download-an-artifact
parameters:
- - *299
- - *300
- - *315
+ - *296
+ - *297
+ - *312
- name: archive_format
in: path
required: true
@@ -41929,14 +41481,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: *316
+ schema: *313
examples:
default:
value:
@@ -41962,14 +41514,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: &317
+ schema: &314
title: Actions cache usage policy for repository
description: GitHub Actions cache usage policy for repository.
type: object
@@ -41981,7 +41533,7 @@ paths:
required:
- repo_cache_size_limit_in_gb
examples:
- default: &318
+ default: &315
value:
repo_cache_size_limit_in_gb: 14
x-github:
@@ -42002,8 +41554,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -42011,9 +41563,9 @@ paths:
required: true
content:
application/json:
- schema: *317
+ schema: *314
examples:
- selected_actions: *318
+ selected_actions: *315
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42033,11 +41585,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
- - &319
+ - &316
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
@@ -42071,7 +41623,7 @@ paths:
description: Response
content:
application/json:
- schema: &320
+ schema: &317
title: Repository actions caches
description: Repository actions caches
type: object
@@ -42113,7 +41665,7 @@ paths:
- total_count
- actions_caches
examples:
- default: &321
+ default: &318
value:
total_count: 1
actions_caches:
@@ -42145,23 +41697,23 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: key
description: A key for identifying the cache.
in: query
required: true
schema:
type: string
- - *319
+ - *316
responses:
'200':
description: Response
content:
application/json:
- schema: *320
+ schema: *317
examples:
- default: *321
+ default: *318
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -42181,8 +41733,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: cache_id
description: The unique identifier of the GitHub Actions cache.
in: path
@@ -42213,9 +41765,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- - *299
- - *300
- - &322
+ - *296
+ - *297
+ - &319
name: job_id
description: The unique identifier of the job.
in: path
@@ -42227,7 +41779,7 @@ paths:
description: Response
content:
application/json:
- schema: &334
+ schema: &331
title: Job
description: Information of a job execution in a workflow run
type: object
@@ -42534,9 +42086,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- - *299
- - *300
- - *322
+ - *296
+ - *297
+ - *319
responses:
'302':
description: Response
@@ -42564,9 +42116,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- - *299
- - *300
- - *322
+ - *296
+ - *297
+ - *319
requestBody:
required: false
content:
@@ -42611,8 +42163,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Status response
@@ -42662,8 +42214,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -42726,8 +42278,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-organization-secrets
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -42745,7 +42297,7 @@ paths:
type: integer
secrets:
type: array
- items: &336
+ items: &333
title: Actions Secret
description: Set secrets for GitHub Actions.
type: object
@@ -42765,7 +42317,7 @@ paths:
- created_at
- updated_at
examples:
- default: &337
+ default: &334
value:
total_count: 2
secrets:
@@ -42798,9 +42350,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-organization-variables
parameters:
- - *299
- - *300
- - *323
+ - *296
+ - *297
+ - *320
- *5
responses:
'200':
@@ -42817,7 +42369,7 @@ paths:
type: integer
variables:
type: array
- items: &340
+ items: &337
title: Actions Variable
type: object
properties:
@@ -42847,7 +42399,7 @@ paths:
- created_at
- updated_at
examples:
- default: &341
+ default: &338
value:
total_count: 2
variables:
@@ -42880,8 +42432,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-github-actions-permissions-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -42890,7 +42442,7 @@ paths:
schema:
type: object
properties:
- enabled: &324
+ enabled: &321
type: boolean
description: Whether GitHub Actions is enabled on the repository.
allowed_actions: *69
@@ -42923,8 +42475,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-github-actions-permissions-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -42935,7 +42487,7 @@ paths:
schema:
type: object
properties:
- enabled: *324
+ enabled: *321
allowed_actions: *69
required:
- enabled
@@ -42966,14 +42518,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: &325
+ schema: &322
type: object
properties:
access_level:
@@ -42991,7 +42543,7 @@ paths:
required:
- access_level
examples:
- default: &326
+ default: &323
value:
access_level: organization
x-github:
@@ -43016,15 +42568,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
application/json:
- schema: *325
+ schema: *322
examples:
- default: *326
+ default: *323
responses:
'204':
description: Response
@@ -43048,8 +42600,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -43080,8 +42632,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -43113,8 +42665,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-default-workflow-permissions-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -43143,8 +42695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-default-workflow-permissions-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Success response
@@ -43184,8 +42736,8 @@ paths:
in: query
schema:
type: string
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -43229,8 +42781,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -43262,8 +42814,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -43337,8 +42889,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'201':
description: Response
@@ -43374,8 +42926,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'201':
description: Response
@@ -43405,8 +42957,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *81
responses:
'200':
@@ -43436,8 +42988,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *81
responses:
'204':
@@ -43464,8 +43016,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *81
responses:
'200': *87
@@ -43490,8 +43042,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *81
requestBody:
required: true
@@ -43540,8 +43092,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *81
requestBody:
required: true
@@ -43591,8 +43143,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *81
responses:
'200': *165
@@ -43622,8 +43174,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *81
- *166
responses:
@@ -43653,9 +43205,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#list-workflow-runs-for-a-repository
parameters:
- - *299
- - *300
- - &344
+ - *296
+ - *297
+ - &341
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.
@@ -43663,7 +43215,7 @@ paths:
required: false
schema:
type: string
- - &345
+ - &342
name: branch
description: Returns workflow runs associated with a branch. Use the name
of the branch of the `push`.
@@ -43671,7 +43223,7 @@ paths:
required: false
schema:
type: string
- - &346
+ - &343
name: event
description: Returns workflow run triggered by the event you specify. For
example, `push`, `pull_request` or `issue`. For more information, see "[Events
@@ -43680,7 +43232,7 @@ paths:
required: false
schema:
type: string
- - &347
+ - &344
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
@@ -43707,7 +43259,7 @@ paths:
- pending
- *4
- *5
- - &348
+ - &345
name: created
description: Returns workflow runs created within the given date-time range.
For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
@@ -43716,7 +43268,7 @@ paths:
schema:
type: string
format: date-time
- - &327
+ - &324
name: exclude_pull_requests
description: If `true` pull requests are omitted from the response (empty
array).
@@ -43725,13 +43277,13 @@ paths:
schema:
type: boolean
default: false
- - &349
+ - &346
name: check_suite_id
description: Returns workflow runs with the `check_suite_id` that you specify.
in: query
schema:
type: integer
- - &350
+ - &347
name: head_sha
description: Only returns workflow runs that are associated with the specified
`head_sha`.
@@ -43754,7 +43306,7 @@ paths:
type: integer
workflow_runs:
type: array
- items: &328
+ items: &325
title: Workflow Run
description: An invocation of a workflow
type: object
@@ -43849,7 +43401,7 @@ paths:
that triggered the run.
type: array
nullable: true
- items: &368
+ items: &365
title: Pull Request Minimal
type: object
properties:
@@ -43968,7 +43520,7 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: &372
+ properties: &369
id:
type: string
description: SHA for the commit
@@ -44019,7 +43571,7 @@ paths:
- name
- email
nullable: true
- required: &373
+ required: &370
- id
- tree_id
- message
@@ -44066,7 +43618,7 @@ paths:
- workflow_url
- pull_requests
examples:
- default: &351
+ default: &348
value:
total_count: 1
workflow_runs:
@@ -44302,24 +43854,24 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run
parameters:
- - *299
- - *300
- - &329
+ - *296
+ - *297
+ - &326
name: run_id
description: The unique identifier of the workflow run.
in: path
required: true
schema:
type: integer
- - *327
+ - *324
responses:
'200':
description: Response
content:
application/json:
- schema: *328
+ schema: *325
examples:
- default: &332
+ default: &329
value:
id: 30433642
name: Build
@@ -44560,9 +44112,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
responses:
'204':
description: Response
@@ -44585,9 +44137,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
responses:
'200':
description: Response
@@ -44708,12 +44260,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-workflow-run-artifacts
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
- *4
- *5
- - *330
+ - *327
responses:
'200':
description: Response
@@ -44729,9 +44281,9 @@ paths:
type: integer
artifacts:
type: array
- items: *314
+ items: *311
examples:
- default: *331
+ default: *328
headers:
Link: *6
x-github:
@@ -44755,25 +44307,25 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run-attempt
parameters:
- - *299
- - *300
- - *329
- - &333
+ - *296
+ - *297
+ - *326
+ - &330
name: attempt_number
description: The attempt number of the workflow run.
in: path
required: true
schema:
type: integer
- - *327
+ - *324
responses:
'200':
description: Response
content:
application/json:
- schema: *328
+ schema: *325
examples:
- default: *332
+ default: *329
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -44796,10 +44348,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt
parameters:
- - *299
- - *300
- - *329
- - *333
+ - *296
+ - *297
+ - *326
+ - *330
- *4
- *5
responses:
@@ -44817,9 +44369,9 @@ paths:
type: integer
jobs:
type: array
- items: *334
+ items: *331
examples:
- default: &335
+ default: &332
value:
total_count: 1
jobs:
@@ -44932,10 +44484,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-attempt-logs
parameters:
- - *299
- - *300
- - *329
- - *333
+ - *296
+ - *297
+ - *326
+ - *330
responses:
'302':
description: Response
@@ -44963,9 +44515,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#cancel-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
responses:
'202':
description: Response
@@ -44998,9 +44550,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
requestBody:
required: true
content:
@@ -45067,9 +44619,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#force-cancel-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
responses:
'202':
description: Response
@@ -45102,9 +44654,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
- 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
@@ -45134,9 +44686,9 @@ paths:
type: integer
jobs:
type: array
- items: *334
+ items: *331
examples:
- default: *335
+ default: *332
headers:
Link: *6
x-github:
@@ -45161,9 +44713,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-logs
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
responses:
'302':
description: Response
@@ -45190,9 +44742,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-workflow-run-logs
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
responses:
'204':
description: Response
@@ -45219,9 +44771,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
responses:
'200':
description: Response
@@ -45281,7 +44833,7 @@ paths:
items:
type: object
properties:
- type: &430
+ type: &427
type: string
description: The type of reviewer.
enum:
@@ -45291,7 +44843,7 @@ paths:
reviewer:
anyOf:
- *19
- - *301
+ - *298
required:
- environment
- wait_timer
@@ -45366,9 +44918,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
requestBody:
required: true
content:
@@ -45415,7 +44967,7 @@ paths:
application/json:
schema:
type: array
- items: &425
+ items: &422
title: Deployment
description: A request for a specific ref(branch,sha,tag) to be
deployed
@@ -45521,7 +45073,7 @@ paths:
- created_at
- updated_at
examples:
- default: &426
+ default: &423
value:
- url: https://api.github.com/repos/octocat/example/deployments/1
id: 1
@@ -45577,9 +45129,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-workflow
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
requestBody:
required: false
content:
@@ -45623,9 +45175,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run
parameters:
- - *299
- - *300
- - *329
+ - *296
+ - *297
+ - *326
requestBody:
required: false
content:
@@ -45672,8 +45224,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-secrets
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -45691,9 +45243,9 @@ paths:
type: integer
secrets:
type: array
- items: *336
+ items: *333
examples:
- default: *337
+ default: *334
headers:
Link: *6
x-github:
@@ -45718,16 +45270,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-public-key
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: *338
+ schema: *335
examples:
- default: *339
+ default: *336
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -45749,17 +45301,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-secret
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *336
+ schema: *333
examples:
- default: &443
+ default: &440
value:
name: GH_TOKEN
created_at: '2019-08-10T14:59:22Z'
@@ -45785,8 +45337,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *168
requestBody:
required: true
@@ -45844,8 +45396,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-a-repository-secret
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *168
responses:
'204':
@@ -45871,9 +45423,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-variables
parameters:
- - *299
- - *300
- - *323
+ - *296
+ - *297
+ - *320
- *5
responses:
'200':
@@ -45890,9 +45442,9 @@ paths:
type: integer
variables:
type: array
- items: *340
+ items: *337
examples:
- default: *341
+ default: *338
headers:
Link: *6
x-github:
@@ -45915,8 +45467,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-a-repository-variable
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -45968,17 +45520,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-a-repository-variable
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *171
responses:
'200':
description: Response
content:
application/json:
- schema: *340
+ schema: *337
examples:
- default: &444
+ default: &441
value:
name: USERNAME
value: octocat
@@ -46004,8 +45556,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-a-repository-variable
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *171
requestBody:
required: true
@@ -46048,8 +45600,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-a-repository-variable
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *171
responses:
'204':
@@ -46075,8 +45627,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#list-repository-workflows
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -46094,7 +45646,7 @@ paths:
type: integer
workflows:
type: array
- items: &342
+ items: &339
title: Workflow
description: A GitHub Actions workflow
type: object
@@ -46201,9 +45753,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#get-a-workflow
parameters:
- - *299
- - *300
- - &343
+ - *296
+ - *297
+ - &340
name: workflow_id
in: path
description: The ID of the workflow. You can also pass the workflow file name
@@ -46218,7 +45770,7 @@ paths:
description: Response
content:
application/json:
- schema: *342
+ schema: *339
examples:
default:
value:
@@ -46251,9 +45803,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#disable-a-workflow
parameters:
- - *299
- - *300
- - *343
+ - *296
+ - *297
+ - *340
responses:
'204':
description: Response
@@ -46278,9 +45830,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#create-a-workflow-dispatch-event
parameters:
- - *299
- - *300
- - *343
+ - *296
+ - *297
+ - *340
responses:
'204':
description: Response
@@ -46331,9 +45883,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#enable-a-workflow
parameters:
- - *299
- - *300
- - *343
+ - *296
+ - *297
+ - *340
responses:
'204':
description: Response
@@ -46360,19 +45912,19 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow
parameters:
- - *299
- - *300
+ - *296
+ - *297
+ - *340
+ - *341
+ - *342
- *343
- *344
+ - *4
+ - *5
- *345
+ - *324
- *346
- *347
- - *4
- - *5
- - *348
- - *327
- - *349
- - *350
responses:
'200':
description: Response
@@ -46388,9 +45940,9 @@ paths:
type: integer
workflow_runs:
type: array
- items: *328
+ items: *325
examples:
- default: *351
+ default: *348
headers:
Link: *6
x-github:
@@ -46413,8 +45965,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-activities
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *9
- *4
- *88
@@ -46578,8 +46130,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#list-assignees
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -46616,8 +46168,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#check-if-a-user-can-be-assigned
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: assignee
in: path
required: true
@@ -46651,8 +46203,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#get-all-autolinks-of-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -46660,7 +46212,7 @@ paths:
application/json:
schema:
type: array
- items: &352
+ items: &349
title: Autolink reference
description: An autolink reference.
type: object
@@ -46714,8 +46266,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#create-an-autolink-reference-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -46754,9 +46306,9 @@ paths:
description: response
content:
application/json:
- schema: *352
+ schema: *349
examples:
- default: &353
+ default: &350
value:
id: 1
key_prefix: TICKET-
@@ -46787,9 +46339,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#get-an-autolink-reference-of-a-repository
parameters:
- - *299
- - *300
- - &354
+ - *296
+ - *297
+ - &351
name: autolink_id
description: The unique identifier of the autolink.
in: path
@@ -46801,9 +46353,9 @@ paths:
description: Response
content:
application/json:
- schema: *352
+ schema: *349
examples:
- default: *353
+ default: *350
'404': *26
x-github:
githubCloudOnly: false
@@ -46823,9 +46375,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository
parameters:
- - *299
- - *300
- - *354
+ - *296
+ - *297
+ - *351
responses:
'204':
description: Response
@@ -46849,8 +46401,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response if Dependabot is enabled
@@ -46897,8 +46449,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#list-branches
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: protected
description: Setting to `true` returns only branches protected by branch protections
or rulesets. When set to `false`, only unprotected branches are returned.
@@ -46936,7 +46488,7 @@ paths:
- url
protected:
type: boolean
- protection: &356
+ protection: &353
title: Branch Protection
description: Branch Protection
type: object
@@ -46978,7 +46530,7 @@ paths:
required:
- contexts
- checks
- enforce_admins: &359
+ enforce_admins: &356
title: Protected Branch Admin Enforced
description: Protected Branch Admin Enforced
type: object
@@ -46993,7 +46545,7 @@ paths:
required:
- url
- enabled
- required_pull_request_reviews: &361
+ required_pull_request_reviews: &358
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
@@ -47014,7 +46566,7 @@ paths:
description: The list of teams with review dismissal
access.
type: array
- items: *301
+ items: *298
apps:
description: The list of apps with review dismissal
access.
@@ -47043,7 +46595,7 @@ paths:
description: The list of teams allowed to bypass
pull request requirements.
type: array
- items: *301
+ items: *298
apps:
description: The list of apps allowed to bypass
pull request requirements.
@@ -47069,7 +46621,7 @@ paths:
required:
- dismiss_stale_reviews
- require_code_owner_reviews
- restrictions: &358
+ restrictions: &355
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
@@ -47132,7 +46684,7 @@ paths:
type: string
teams:
type: array
- items: *301
+ items: *298
apps:
type: array
items:
@@ -47346,9 +46898,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#get-a-branch
parameters:
- - *299
- - *300
- - &357
+ - *296
+ - *297
+ - &354
name: branch
description: The name of the branch. Cannot contain wildcard characters. To
use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.14/graphql).
@@ -47362,14 +46914,14 @@ paths:
description: Response
content:
application/json:
- schema: &367
+ schema: &364
title: Branch With Protection
description: Branch With Protection
type: object
properties:
name:
type: string
- commit: &403
+ commit: &400
title: Commit
description: Commit
type: object
@@ -47403,7 +46955,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: &355
+ properties: &352
name:
type: string
example: '"Chris Wanstrath"'
@@ -47419,7 +46971,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *355
+ properties: *352
nullable: true
message:
type: string
@@ -47440,7 +46992,7 @@ paths:
required:
- sha
- url
- verification: &450
+ verification: &447
title: Verification
type: object
properties:
@@ -47506,7 +47058,7 @@ paths:
type: integer
files:
type: array
- items: &412
+ items: &409
title: Diff Entry
description: Diff Entry
type: object
@@ -47590,7 +47142,7 @@ paths:
- self
protected:
type: boolean
- protection: *356
+ protection: *353
protection_url:
type: string
format: uri
@@ -47694,7 +47246,7 @@ paths:
contexts: []
checks: []
protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection
- '301': *311
+ '301': *308
'404': *26
x-github:
githubCloudOnly: false
@@ -47716,15 +47268,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-branch-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
content:
application/json:
- schema: *356
+ schema: *353
examples:
default:
value:
@@ -47918,9 +47470,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-branch-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: true
content:
@@ -48175,7 +47727,7 @@ paths:
url:
type: string
format: uri
- required_status_checks: &364
+ required_status_checks: &361
title: Status Check Policy
description: Status Check Policy
type: object
@@ -48251,7 +47803,7 @@ paths:
items: *19
teams:
type: array
- items: *301
+ items: *298
apps:
type: array
items: *25
@@ -48269,7 +47821,7 @@ paths:
items: *19
teams:
type: array
- items: *301
+ items: *298
apps:
type: array
items: *25
@@ -48327,7 +47879,7 @@ paths:
additionalProperties: false
required:
- enabled
- restrictions: *358
+ restrictions: *355
required_conversation_resolution:
type: object
properties:
@@ -48439,9 +47991,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-branch-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'204':
description: Response
@@ -48466,17 +48018,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-admin-branch-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
- default: &360
+ default: &357
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
enabled: true
@@ -48498,17 +48050,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-admin-branch-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
- default: *360
+ default: *357
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -48527,9 +48079,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-admin-branch-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'204':
description: Response
@@ -48554,17 +48106,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-pull-request-review-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
content:
application/json:
- schema: *361
+ schema: *358
examples:
- default: &362
+ default: &359
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
@@ -48660,9 +48212,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: false
content:
@@ -48760,9 +48312,9 @@ paths:
description: Response
content:
application/json:
- schema: *361
+ schema: *358
examples:
- default: *362
+ default: *359
'422': *35
x-github:
githubCloudOnly: false
@@ -48783,9 +48335,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-pull-request-review-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'204':
description: Response
@@ -48812,17 +48364,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-commit-signature-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
- default: &363
+ default: &360
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled: true
@@ -48845,17 +48397,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#create-commit-signature-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
content:
application/json:
- schema: *359
+ schema: *356
examples:
- default: *363
+ default: *360
'404': *26
x-github:
githubCloudOnly: false
@@ -48875,9 +48427,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-commit-signature-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'204':
description: Response
@@ -48902,17 +48454,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-status-checks-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: &365
+ default: &362
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
@@ -48938,9 +48490,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-status-check-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: false
content:
@@ -48992,9 +48544,9 @@ paths:
description: Response
content:
application/json:
- schema: *364
+ schema: *361
examples:
- default: *365
+ default: *362
'404': *26
'422': *35
x-github:
@@ -49016,9 +48568,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-protection
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'204':
description: Response
@@ -49042,9 +48594,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-all-status-check-contexts
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
@@ -49078,9 +48630,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-status-check-contexts
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: false
content:
@@ -49147,9 +48699,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-status-check-contexts
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: false
content:
@@ -49213,9 +48765,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-contexts
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
content:
application/json:
@@ -49281,15 +48833,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
content:
application/json:
- schema: *358
+ schema: *355
examples:
default:
value:
@@ -49380,9 +48932,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'204':
description: Response
@@ -49405,9 +48957,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
@@ -49417,7 +48969,7 @@ paths:
type: array
items: *25
examples:
- default: &366
+ default: &363
value:
- id: 1
slug: octoapp
@@ -49474,9 +49026,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-app-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: true
content:
@@ -49510,7 +49062,7 @@ paths:
type: array
items: *25
examples:
- default: *366
+ default: *363
'422': *35
x-github:
githubCloudOnly: false
@@ -49531,9 +49083,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-app-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: true
content:
@@ -49567,7 +49119,7 @@ paths:
type: array
items: *25
examples:
- default: *366
+ default: *363
'422': *35
x-github:
githubCloudOnly: false
@@ -49588,9 +49140,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-app-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: true
content:
@@ -49624,7 +49176,7 @@ paths:
type: array
items: *25
examples:
- default: *366
+ default: *363
'422': *35
x-github:
githubCloudOnly: false
@@ -49646,9 +49198,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
@@ -49656,7 +49208,7 @@ paths:
application/json:
schema:
type: array
- items: *301
+ items: *298
examples:
default: *283
'404': *26
@@ -49678,9 +49230,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-team-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: false
content:
@@ -49716,7 +49268,7 @@ paths:
application/json:
schema:
type: array
- items: *301
+ items: *298
examples:
default: *283
'422': *35
@@ -49739,9 +49291,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-team-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: false
content:
@@ -49777,7 +49329,7 @@ paths:
application/json:
schema:
type: array
- items: *301
+ items: *298
examples:
default: *283
'422': *35
@@ -49800,9 +49352,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-team-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
content:
application/json:
@@ -49837,7 +49389,7 @@ paths:
application/json:
schema:
type: array
- items: *301
+ items: *298
examples:
default: *283
'422': *35
@@ -49861,9 +49413,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
responses:
'200':
description: Response
@@ -49897,9 +49449,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-user-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: true
content:
@@ -49957,9 +49509,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-user-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: true
content:
@@ -50017,9 +49569,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-user-access-restrictions
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: true
content:
@@ -50079,9 +49631,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#rename-a-branch
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
requestBody:
required: true
content:
@@ -50103,7 +49655,7 @@ paths:
description: Response
content:
application/json:
- schema: *367
+ schema: *364
examples:
default:
value:
@@ -50216,8 +49768,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#create-a-check-run
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -50496,7 +50048,7 @@ paths:
description: Response
content:
application/json:
- schema: &369
+ schema: &366
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -50615,8 +50167,8 @@ paths:
do not necessarily indicate pull requests that triggered the
check.
type: array
- items: *368
- deployment: &623
+ items: *365
+ deployment: &618
title: Deployment
description: A deployment created as the result of an Actions
check run from a workflow that references an environment
@@ -50896,9 +50448,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#get-a-check-run
parameters:
- - *299
- - *300
- - &370
+ - *296
+ - *297
+ - &367
name: check_run_id
description: The unique identifier of the check run.
in: path
@@ -50910,9 +50462,9 @@ paths:
description: Response
content:
application/json:
- schema: *369
+ schema: *366
examples:
- default: &371
+ default: &368
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
@@ -51012,9 +50564,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#update-a-check-run
parameters:
- - *299
- - *300
- - *370
+ - *296
+ - *297
+ - *367
requestBody:
required: true
content:
@@ -51254,9 +50806,9 @@ paths:
description: Response
content:
application/json:
- schema: *369
+ schema: *366
examples:
- default: *371
+ default: *368
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51276,9 +50828,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-run-annotations
parameters:
- - *299
- - *300
- - *370
+ - *296
+ - *297
+ - *367
- *4
- *5
responses:
@@ -51373,9 +50925,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#rerequest-a-check-run
parameters:
- - *299
- - *300
- - *370
+ - *296
+ - *297
+ - *367
responses:
'201':
description: Response
@@ -51419,8 +50971,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -51442,7 +50994,7 @@ paths:
description: Response when the suite already exists
content:
application/json:
- schema: &374
+ schema: &371
title: CheckSuite
description: A suite of checks performed on the code of a given code
change
@@ -51506,7 +51058,7 @@ paths:
nullable: true
pull_requests:
type: array
- items: *368
+ items: *365
nullable: true
app:
title: GitHub app
@@ -51532,8 +51084,8 @@ paths:
title: Simple Commit
description: A commit.
type: object
- properties: *372
- required: *373
+ properties: *369
+ required: *370
latest_check_runs_count:
type: integer
check_runs_url:
@@ -51561,7 +51113,7 @@ paths:
- check_runs_url
- pull_requests
examples:
- default: &375
+ default: &372
value:
id: 5
node_id: MDEwOkNoZWNrU3VpdGU1
@@ -51852,9 +51404,9 @@ paths:
description: Response when the suite was created
content:
application/json:
- schema: *374
+ schema: *371
examples:
- default: *375
+ default: *372
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -51873,8 +51425,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -52183,9 +51735,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite
parameters:
- - *299
- - *300
- - &376
+ - *296
+ - *297
+ - &373
name: check_suite_id
description: The unique identifier of the check suite.
in: path
@@ -52197,9 +51749,9 @@ paths:
description: Response
content:
application/json:
- schema: *374
+ schema: *371
examples:
- default: *375
+ default: *372
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -52222,17 +51774,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-runs-in-a-check-suite
parameters:
- - *299
- - *300
- - *376
- - &409
+ - *296
+ - *297
+ - *373
+ - &406
name: check_name
description: Returns check runs with the specified `name`.
in: query
required: false
schema:
type: string
- - &410
+ - &407
name: status
description: Returns check runs with the specified `status`.
in: query
@@ -52271,9 +51823,9 @@ paths:
type: integer
check_runs:
type: array
- items: *369
+ items: *366
examples:
- default: &411
+ default: &408
value:
total_count: 1
check_runs:
@@ -52375,9 +51927,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#rerequest-a-check-suite
parameters:
- - *299
- - *300
- - *376
+ - *296
+ - *297
+ - *373
responses:
'201':
description: Response
@@ -52410,20 +51962,20 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *183
- *184
- *5
- *4
- - &388
+ - &385
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: *377
+ schema: *374
- *9
- name: sort
description: The property by which to sort the results.
@@ -52446,7 +51998,7 @@ paths:
be returned.
in: query
required: false
- schema: *378
+ schema: *375
responses:
'200':
description: Response
@@ -52462,7 +52014,7 @@ paths:
updated_at: *100
url: *97
html_url: *98
- instances_url: *379
+ instances_url: *376
state: *92
fixed_at: *102
dismissed_by:
@@ -52473,11 +52025,11 @@ paths:
required: *18
nullable: true
dismissed_at: *101
- dismissed_reason: *380
- dismissed_comment: *381
- rule: *382
- tool: *383
- most_recent_instance: *384
+ dismissed_reason: *377
+ dismissed_comment: *378
+ rule: *379
+ tool: *380
+ most_recent_instance: *381
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -52603,7 +52155,7 @@ paths:
classifications: []
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances
'304': *42
- '403': &385
+ '403': &382
description: Response if GitHub Advanced Security is not enabled for this
repository
content:
@@ -52630,9 +52182,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-alert
parameters:
- - *299
- - *300
- - &386
+ - *296
+ - *297
+ - &383
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the
@@ -52646,7 +52198,7 @@ paths:
description: Response
content:
application/json:
- schema: &387
+ schema: &384
type: object
properties:
number: *93
@@ -52654,7 +52206,7 @@ paths:
updated_at: *100
url: *97
html_url: *98
- instances_url: *379
+ instances_url: *376
state: *92
fixed_at: *102
dismissed_by:
@@ -52665,8 +52217,8 @@ paths:
required: *18
nullable: true
dismissed_at: *101
- dismissed_reason: *380
- dismissed_comment: *381
+ dismissed_reason: *377
+ dismissed_comment: *378
rule:
type: object
properties:
@@ -52720,8 +52272,8 @@ paths:
type: string
description: A link to the documentation for the rule used
to detect the alert.
- tool: *383
- most_recent_instance: *384
+ tool: *380
+ most_recent_instance: *381
dismissal_approved_by:
title: Simple User
description: A GitHub user.
@@ -52820,7 +52372,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'304': *42
- '403': *385
+ '403': *382
'404': *26
'503': *104
x-github:
@@ -52840,9 +52392,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- - *299
- - *300
- - *386
+ - *296
+ - *297
+ - *383
requestBody:
required: true
content:
@@ -52857,8 +52409,8 @@ paths:
enum:
- open
- dismissed
- dismissed_reason: *380
- dismissed_comment: *381
+ dismissed_reason: *377
+ dismissed_comment: *378
assignees:
description: The list of users to assign to the code scanning alert.
An empty array unassigns all previous assignees from the alert.
@@ -52884,7 +52436,7 @@ paths:
description: Response
content:
application/json:
- schema: *387
+ schema: *384
examples:
default:
value:
@@ -52960,7 +52512,7 @@ paths:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
'400': *34
- '403': &396
+ '403': &393
description: Response if the repository is archived or if GitHub Advanced
Security is not enabled for this repository
content:
@@ -52987,12 +52539,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
parameters:
- - *299
- - *300
- - *386
+ - *296
+ - *297
+ - *383
- *5
- *4
- - *388
+ - *385
responses:
'200':
description: Response
@@ -53003,10 +52555,10 @@ paths:
items:
type: object
properties:
- ref: *377
- analysis_key: *389
- environment: *390
- category: *391
+ ref: *374
+ analysis_key: *386
+ environment: *387
+ category: *388
state:
type: string
description: State of a code scanning alert instance.
@@ -53021,7 +52573,7 @@ paths:
properties:
text:
type: string
- location: *392
+ location: *389
html_url:
type: string
classifications:
@@ -53029,7 +52581,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: *393
+ items: *390
examples:
default:
value:
@@ -53068,7 +52620,7 @@ paths:
end_column: 50
classifications:
- source
- '403': *385
+ '403': *382
'404': *26
'503': *104
x-github:
@@ -53102,8 +52654,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *183
- *184
- *5
@@ -53114,12 +52666,12 @@ paths:
for a branch can be formatted either as `refs/heads/` or simply
``. To reference a pull request use `refs/pull//merge`.
required: false
- schema: *377
+ schema: *374
- name: sarif_id
in: query
description: Filter analyses belonging to the same SARIF upload.
required: false
- schema: &394
+ schema: &391
type: string
description: An identifier for the upload.
example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
@@ -53140,23 +52692,23 @@ paths:
application/json:
schema:
type: array
- items: &395
+ items: &392
type: object
properties:
- ref: *377
- commit_sha: &397
+ ref: *374
+ commit_sha: &394
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: *389
+ analysis_key: *386
environment:
type: string
description: Identifies the variable values associated with
the environment in which this analysis was performed.
- category: *391
+ category: *388
error:
type: string
example: error reading field xyz
@@ -53180,8 +52732,8 @@ paths:
description: The REST API URL of the analysis resource.
format: uri
readOnly: true
- sarif_id: *394
- tool: *383
+ sarif_id: *391
+ tool: *380
deletable:
type: boolean
warning:
@@ -53242,7 +52794,7 @@ paths:
version: 1.2.0
deletable: true
warning: ''
- '403': *385
+ '403': *382
'404': *26
'503': *104
x-github:
@@ -53278,8 +52830,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -53292,7 +52844,7 @@ paths:
description: Response
content:
application/json:
- schema: *395
+ schema: *392
examples:
response:
summary: application/json response
@@ -53346,7 +52898,7 @@ paths:
properties:
- github/alertNumber: 2
- github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2
- '403': *385
+ '403': *382
'404': *26
'503': *104
x-github:
@@ -53428,8 +52980,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: analysis_id
in: path
description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses`
@@ -53482,7 +53034,7 @@ paths:
next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41
confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete
'400': *34
- '403': *396
+ '403': *393
'404': *26
'503': *104
x-github:
@@ -53504,8 +53056,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -53567,7 +53119,7 @@ paths:
query_suite: default
updated_at: '2023-01-19T11:21:34Z'
schedule: weekly
- '403': *385
+ '403': *382
'404': *26
'503': *104
x-github:
@@ -53588,8 +53140,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -53660,7 +53212,7 @@ paths:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
- '403': *396
+ '403': *393
'404': *26
'409':
description: Response if there is already a validation run in progress with
@@ -53731,8 +53283,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -53740,7 +53292,7 @@ paths:
schema:
type: object
properties:
- commit_sha: *397
+ commit_sha: *394
ref:
type: string
description: |-
@@ -53793,7 +53345,7 @@ paths:
schema:
type: object
properties:
- id: *394
+ id: *391
url:
type: string
description: The REST API URL for checking the status of the upload.
@@ -53807,7 +53359,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': *396
+ '403': *393
'404': *26
'413':
description: Payload Too Large if the sarif field is too large
@@ -53830,8 +53382,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: sarif_id
description: The SARIF ID obtained after uploading.
in: path
@@ -53877,7 +53429,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': *385
+ '403': *382
'404':
description: Not Found if the sarif id does not match any upload
'503': *104
@@ -53902,8 +53454,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-codeowners-errors
parameters:
- - *299
- - *300
+ - *296
+ - *297
- 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
@@ -54026,8 +53578,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#list-repository-collaborators
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: affiliation
description: Filter collaborators returned by their affiliation. `outside`
means all outside collaborators of an organization-owned repository. `direct`
@@ -54069,7 +53621,7 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: &398
+ properties: &395
login:
type: string
example: octocat
@@ -54162,7 +53714,7 @@ paths:
user_view_type:
type: string
example: public
- required: &399
+ required: &396
- avatar_url
- events_url
- followers_url
@@ -54235,8 +53787,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *8
responses:
'204':
@@ -54273,8 +53825,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#add-a-repository-collaborator
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *8
requestBody:
required: false
@@ -54344,8 +53896,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#remove-a-repository-collaborator
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *8
responses:
'204':
@@ -54377,8 +53929,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#get-repository-permissions-for-a-user
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *8
responses:
'200':
@@ -54399,8 +53951,8 @@ paths:
title: Collaborator
description: Collaborator
type: object
- properties: *398
- required: *399
+ properties: *395
+ required: *396
nullable: true
required:
- permission
@@ -54455,8 +54007,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -54466,7 +54018,7 @@ paths:
application/json:
schema:
type: array
- items: &400
+ items: &397
title: Commit Comment
description: Commit Comment
type: object
@@ -54524,7 +54076,7 @@ paths:
- created_at
- updated_at
examples:
- default: &405
+ default: &402
value:
- html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -54583,17 +54135,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *400
+ schema: *397
examples:
- default: &406
+ default: &403
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -54650,8 +54202,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#update-a-commit-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
requestBody:
required: true
@@ -54674,7 +54226,7 @@ paths:
description: Response
content:
application/json:
- schema: *400
+ schema: *397
examples:
default:
value:
@@ -54725,8 +54277,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#delete-a-commit-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
responses:
'204':
@@ -54748,8 +54300,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-commit-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -54776,7 +54328,7 @@ paths:
application/json:
schema:
type: array
- items: &401
+ items: &398
title: Reaction
description: Reactions to conversations provide a way to help people
express their feelings more simply and effectively.
@@ -54819,7 +54371,7 @@ paths:
- content
- created_at
examples:
- default: &461
+ default: &458
value:
- id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -54864,8 +54416,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-commit-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
requestBody:
required: true
@@ -54898,9 +54450,9 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: &402
+ default: &399
value:
id: 1
node_id: MDg6UmVhY3Rpb24x
@@ -54929,9 +54481,9 @@ paths:
description: Reaction created
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'422': *35
x-github:
githubCloudOnly: false
@@ -54953,10 +54505,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-commit-comment-reaction
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
- - &462
+ - &459
name: reaction_id
description: The unique identifier of the reaction.
in: path
@@ -55011,8 +54563,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: sha
description: 'SHA or branch to start listing commits from. Default: the repository’s
default branch (usually `main`).'
@@ -55068,9 +54620,9 @@ paths:
application/json:
schema:
type: array
- items: *403
+ items: *400
examples:
- default: &510
+ default: &507
value:
- url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -55163,9 +54715,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-branches-for-head-commit
parameters:
- - *299
- - *300
- - &404
+ - *296
+ - *297
+ - &401
name: commit_sha
description: The SHA of the commit.
in: path
@@ -55237,9 +54789,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments
parameters:
- - *299
- - *300
- - *404
+ - *296
+ - *297
+ - *401
- *4
- *5
responses:
@@ -55249,9 +54801,9 @@ paths:
application/json:
schema:
type: array
- items: *400
+ items: *397
examples:
- default: *405
+ default: *402
headers:
Link: *6
x-github:
@@ -55279,9 +54831,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/comments#create-a-commit-comment
parameters:
- - *299
- - *300
- - *404
+ - *296
+ - *297
+ - *401
requestBody:
required: true
content:
@@ -55316,9 +54868,9 @@ paths:
description: Response
content:
application/json:
- schema: *400
+ schema: *397
examples:
- default: *406
+ default: *403
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/comments/1
@@ -55346,9 +54898,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-pull-requests-associated-with-a-commit
parameters:
- - *299
- - *300
- - *404
+ - *296
+ - *297
+ - *401
- *4
- *5
responses:
@@ -55358,7 +54910,7 @@ paths:
application/json:
schema:
type: array
- items: &502
+ items: &499
title: Pull Request Simple
description: Pull Request Simple
type: object
@@ -55510,7 +55062,7 @@ paths:
nullable: true
requested_teams:
type: array
- items: *301
+ items: *298
nullable: true
head:
type: object
@@ -55579,7 +55131,7 @@ paths:
- review_comment
- self
author_association: *110
- auto_merge: *407
+ auto_merge: *404
draft:
description: Indicates whether or not the pull request is a
draft.
@@ -55618,7 +55170,7 @@ paths:
- author_association
- auto_merge
examples:
- default: &503
+ default: &500
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -56155,11 +55707,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#get-a-commit
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *5
- *4
- - &408
+ - &405
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)"
@@ -56174,9 +55726,9 @@ paths:
description: Response
content:
application/json:
- schema: *403
+ schema: *400
examples:
- default: &487
+ default: &484
value:
url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
@@ -56286,11 +55838,11 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-runs-for-a-git-reference
parameters:
- - *299
- - *300
- - *408
- - *409
- - *410
+ - *296
+ - *297
+ - *405
+ - *406
+ - *407
- name: filter
description: Filters check runs by their `completed_at` timestamp. `latest`
returns the most recent check runs.
@@ -56324,9 +55876,9 @@ paths:
type: integer
check_runs:
type: array
- items: *369
+ items: *366
examples:
- default: *411
+ default: *408
headers:
Link: *6
x-github:
@@ -56351,9 +55903,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/checks/suites#list-check-suites-for-a-git-reference
parameters:
- - *299
- - *300
- - *408
+ - *296
+ - *297
+ - *405
- name: app_id
description: Filters check suites by GitHub App `id`.
in: query
@@ -56361,7 +55913,7 @@ paths:
schema:
type: integer
example: 1
- - *409
+ - *406
- *4
- *5
responses:
@@ -56379,7 +55931,7 @@ paths:
type: integer
check_suites:
type: array
- items: *374
+ items: *371
examples:
default:
value:
@@ -56579,9 +56131,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#get-the-combined-status-for-a-specific-reference
parameters:
- - *299
- - *300
- - *408
+ - *296
+ - *297
+ - *405
- *4
- *5
responses:
@@ -56779,9 +56331,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#list-commit-statuses-for-a-reference
parameters:
- - *299
- - *300
- - *408
+ - *296
+ - *297
+ - *405
- *4
- *5
responses:
@@ -56791,7 +56343,7 @@ paths:
application/json:
schema:
type: array
- items: &543
+ items: &540
title: Status
description: The status of a commit.
type: object
@@ -56872,7 +56424,7 @@ paths:
site_admin: false
headers:
Link: *6
- '301': *311
+ '301': *308
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -56940,8 +56492,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/commits#compare-two-commits
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *5
- *4
- name: basehead
@@ -56984,8 +56536,8 @@ paths:
type: string
format: uri
example: https://github.com/octocat/Hello-World/compare/master...topic.patch
- base_commit: *403
- merge_base_commit: *403
+ base_commit: *400
+ merge_base_commit: *400
status:
type: string
enum:
@@ -57005,10 +56557,10 @@ paths:
example: 6
commits:
type: array
- items: *403
+ items: *400
files:
type: array
- items: *412
+ items: *409
required:
- url
- html_url
@@ -57287,8 +56839,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-repository-content
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: path
description: path parameter
in: path
@@ -57431,7 +56983,7 @@ paths:
- type
- url
examples:
- response-if-content-is-a-file: &413
+ response-if-content-is-a-file: &410
summary: Response if content is a file
value:
type: file
@@ -57563,7 +57115,7 @@ paths:
- size
- type
- url
- - &515
+ - &512
title: Content File
description: Content File
type: object
@@ -57764,7 +57316,7 @@ paths:
- url
- submodule_git_url
examples:
- response-if-content-is-a-file: *413
+ response-if-content-is-a-file: *410
response-if-content-is-a-directory:
summary: Response if content is a directory and the application/json
media type is requested
@@ -57833,7 +57385,7 @@ paths:
html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9
'404': *26
'403': *43
- '302': &519
+ '302': &516
description: Found
'304': *42
x-github:
@@ -57857,8 +57409,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#create-or-update-file-contents
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: path
description: path parameter
in: path
@@ -57951,7 +57503,7 @@ paths:
description: Response
content:
application/json:
- schema: &414
+ schema: &411
title: File Commit
description: File Commit
type: object
@@ -58097,7 +57649,7 @@ paths:
description: Response
content:
application/json:
- schema: *414
+ schema: *411
examples:
example-for-creating-a-file:
value:
@@ -58148,7 +57700,7 @@ paths:
schema:
oneOf:
- *24
- - &445
+ - &442
description: Repository rule violation was detected
type: object
properties:
@@ -58201,8 +57753,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#delete-a-file
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: path
description: path parameter
in: path
@@ -58263,7 +57815,7 @@ paths:
description: Response
content:
application/json:
- schema: *414
+ schema: *411
examples:
default:
value:
@@ -58314,8 +57866,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-contributors
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: anon
description: Set to `1` or `true` to include anonymous contributors in results.
in: query
@@ -58438,8 +57990,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *191
- *192
- *193
@@ -58451,7 +58003,7 @@ paths:
schema:
type: string
- *195
- - *415
+ - *412
- *196
- *197
- *9
@@ -58482,7 +58034,7 @@ paths:
application/json:
schema:
type: array
- items: &419
+ items: &416
type: object
description: A Dependabot alert.
properties:
@@ -58515,7 +58067,7 @@ paths:
enum:
- development
- runtime
- security_advisory: *416
+ security_advisory: *413
security_vulnerability: *96
url: *97
html_url: *98
@@ -58546,8 +58098,8 @@ paths:
nullable: true
maxLength: 280
fixed_at: *102
- auto_dismissed_at: *417
- dismissal_request: *418
+ auto_dismissed_at: *414
+ dismissal_request: *415
required:
- number
- state
@@ -58774,9 +58326,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#get-a-dependabot-alert
parameters:
- - *299
- - *300
- - &420
+ - *296
+ - *297
+ - &417
name: alert_number
in: path
description: |-
@@ -58791,7 +58343,7 @@ paths:
description: Response
content:
application/json:
- schema: *419
+ schema: *416
examples:
default:
value:
@@ -58895,9 +58447,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- - *299
- - *300
- - *420
+ - *296
+ - *297
+ - *417
requestBody:
required: true
content:
@@ -58942,7 +58494,7 @@ paths:
description: Response
content:
application/json:
- schema: *419
+ schema: *416
examples:
default:
value:
@@ -59071,8 +58623,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#list-repository-secrets
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -59090,7 +58642,7 @@ paths:
type: integer
secrets:
type: array
- items: &423
+ items: &420
title: Dependabot Secret
description: Set secrets for Dependabot.
type: object
@@ -59143,16 +58695,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-public-key
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: *421
+ schema: *418
examples:
- default: *422
+ default: *419
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -59172,15 +58724,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-secret
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *423
+ schema: *420
examples:
default:
value:
@@ -59206,8 +58758,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *168
requestBody:
required: true
@@ -59260,8 +58812,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#delete-a-repository-secret
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *168
responses:
'204':
@@ -59284,8 +58836,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits
parameters:
- - *299
- - *300
+ - *296
+ - *297
- 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
@@ -59445,8 +58997,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -59671,8 +59223,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -59747,7 +59299,7 @@ paths:
- version
- url
additionalProperties: false
- metadata: &424
+ metadata: &421
title: metadata
description: User-defined metadata to store domain-specific information
limited to 8 keys with scalar values.
@@ -59780,7 +59332,7 @@ paths:
the root of the Git repository.
example: "/src/build/package-lock.json"
additionalProperties: false
- metadata: *424
+ metadata: *421
resolved:
type: object
description: A collection of resolved package dependencies.
@@ -59793,7 +59345,7 @@ paths:
for more details.
example: pkg:/npm/%40actions/http-client@1.0.11
pattern: "^pkg"
- metadata: *424
+ metadata: *421
relationship:
type: string
description: A notation of whether a dependency is requested
@@ -59922,8 +59474,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: sha
description: The SHA recorded at creation time.
in: query
@@ -59963,9 +59515,9 @@ paths:
application/json:
schema:
type: array
- items: *425
+ items: *422
examples:
- default: *426
+ default: *423
headers:
Link: *6
x-github:
@@ -60031,8 +59583,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#create-a-deployment
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -60113,7 +59665,7 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *422
examples:
simple-example:
summary: Simple example
@@ -60186,9 +59738,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#get-a-deployment
parameters:
- - *299
- - *300
- - &427
+ - *296
+ - *297
+ - &424
name: deployment_id
description: deployment_id parameter
in: path
@@ -60200,7 +59752,7 @@ paths:
description: Response
content:
application/json:
- schema: *425
+ schema: *422
examples:
default:
value:
@@ -60265,9 +59817,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#delete-a-deployment
parameters:
- - *299
- - *300
- - *427
+ - *296
+ - *297
+ - *424
responses:
'204':
description: Response
@@ -60289,9 +59841,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#list-deployment-statuses
parameters:
- - *299
- - *300
- - *427
+ - *296
+ - *297
+ - *424
- *4
- *5
responses:
@@ -60301,7 +59853,7 @@ paths:
application/json:
schema:
type: array
- items: &428
+ items: &425
title: Deployment Status
description: The status of a deployment.
type: object
@@ -60462,9 +60014,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#create-a-deployment-status
parameters:
- - *299
- - *300
- - *427
+ - *296
+ - *297
+ - *424
requestBody:
required: true
content:
@@ -60539,9 +60091,9 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *425
examples:
- default: &429
+ default: &426
value:
url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1
id: 1
@@ -60597,9 +60149,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#get-a-deployment-status
parameters:
- - *299
- - *300
- - *427
+ - *296
+ - *297
+ - *424
- name: status_id
in: path
required: true
@@ -60610,9 +60162,9 @@ paths:
description: Response
content:
application/json:
- schema: *428
+ schema: *425
examples:
- default: *429
+ default: *426
'404': *26
x-github:
githubCloudOnly: false
@@ -60637,8 +60189,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-dispatch-event
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -60695,8 +60247,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#list-environments
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -60713,7 +60265,7 @@ paths:
type: integer
environments:
type: array
- items: &431
+ items: &428
title: Environment
description: Details of a deployment environment
type: object
@@ -60765,7 +60317,7 @@ paths:
type:
type: string
example: wait_timer
- wait_timer: &433
+ wait_timer: &430
type: integer
example: 30
description: The amount of time to delay a job after
@@ -60802,11 +60354,11 @@ paths:
items:
type: object
properties:
- type: *430
+ type: *427
reviewer:
anyOf:
- *19
- - *301
+ - *298
required:
- id
- node_id
@@ -60826,7 +60378,7 @@ paths:
- id
- node_id
- type
- deployment_branch_policy: &434
+ deployment_branch_policy: &431
type: object
description: The type of deployment branch policy for this
environment. To allow all branches to deploy, set to `null`.
@@ -60941,9 +60493,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#get-an-environment
parameters:
- - *299
- - *300
- - &432
+ - *296
+ - *297
+ - &429
name: environment_name
in: path
required: true
@@ -60956,9 +60508,9 @@ paths:
description: Response
content:
application/json:
- schema: *431
+ schema: *428
examples:
- default: &435
+ default: &432
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
@@ -61041,9 +60593,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#create-or-update-an-environment
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
requestBody:
required: false
content:
@@ -61052,7 +60604,7 @@ paths:
type: object
nullable: true
properties:
- wait_timer: *433
+ wait_timer: *430
prevent_self_review:
type: boolean
example: false
@@ -61069,13 +60621,13 @@ paths:
items:
type: object
properties:
- type: *430
+ type: *427
id:
type: integer
description: The id of the user or team who can review the
deployment
example: 4532992
- deployment_branch_policy: *434
+ deployment_branch_policy: *431
additionalProperties: false
examples:
default:
@@ -61095,9 +60647,9 @@ paths:
description: Response
content:
application/json:
- schema: *431
+ schema: *428
examples:
- default: *435
+ default: *432
'422':
description: Validation error when the environment name is invalid or when
`protected_branches` and `custom_branch_policies` in `deployment_branch_policy`
@@ -61121,9 +60673,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#delete-an-environment
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
responses:
'204':
description: Default response
@@ -61148,9 +60700,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#list-deployment-branch-policies
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
- *4
- *5
responses:
@@ -61168,7 +60720,7 @@ paths:
example: 2
branch_policies:
type: array
- items: &436
+ items: &433
title: Deployment branch policy
description: Details of a deployment branch or tag policy.
type: object
@@ -61225,9 +60777,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#create-a-deployment-branch-policy
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
requestBody:
required: true
content:
@@ -61273,9 +60825,9 @@ paths:
description: Response
content:
application/json:
- schema: *436
+ schema: *433
examples:
- example-wildcard: &437
+ example-wildcard: &434
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
@@ -61317,10 +60869,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#get-a-deployment-branch-policy
parameters:
- - *299
- - *300
- - *432
- - &438
+ - *296
+ - *297
+ - *429
+ - &435
name: branch_policy_id
in: path
required: true
@@ -61332,9 +60884,9 @@ paths:
description: Response
content:
application/json:
- schema: *436
+ schema: *433
examples:
- default: *437
+ default: *434
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61353,10 +60905,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- - *299
- - *300
- - *432
- - *438
+ - *296
+ - *297
+ - *429
+ - *435
requestBody:
required: true
content:
@@ -61384,9 +60936,9 @@ paths:
description: Response
content:
application/json:
- schema: *436
+ schema: *433
examples:
- default: *437
+ default: *434
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61405,10 +60957,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#delete-a-deployment-branch-policy
parameters:
- - *299
- - *300
- - *432
- - *438
+ - *296
+ - *297
+ - *429
+ - *435
responses:
'204':
description: Response
@@ -61433,9 +60985,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment
parameters:
- - *432
- - *300
- - *299
+ - *429
+ - *297
+ - *296
responses:
'200':
description: List of deployment protection rules
@@ -61451,7 +61003,7 @@ paths:
example: 10
custom_deployment_protection_rules:
type: array
- items: &439
+ items: &436
title: Deployment protection rule
description: Deployment protection rule
type: object
@@ -61470,7 +61022,7 @@ paths:
example: true
description: Whether the deployment protection rule is enabled
for the environment.
- app: &440
+ app: &437
title: Custom deployment protection rule app
description: A GitHub App that is providing a custom deployment
protection rule.
@@ -61569,9 +61121,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment
parameters:
- - *432
- - *300
- - *299
+ - *429
+ - *297
+ - *296
requestBody:
content:
application/json:
@@ -61592,9 +61144,9 @@ paths:
description: The enabled custom deployment protection rule
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: &441
+ default: &438
value:
id: 3
node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
@@ -61629,9 +61181,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment
parameters:
- - *432
- - *300
- - *299
+ - *429
+ - *297
+ - *296
- *5
- *4
responses:
@@ -61650,7 +61202,7 @@ paths:
example: 35
available_custom_deployment_protection_rule_integrations:
type: array
- items: *440
+ items: *437
examples:
default:
value:
@@ -61685,10 +61237,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule
parameters:
- - *299
- - *300
- - *432
- - &442
+ - *296
+ - *297
+ - *429
+ - &439
name: protection_rule_id
description: The unique identifier of the protection rule.
in: path
@@ -61700,9 +61252,9 @@ paths:
description: Response
content:
application/json:
- schema: *439
+ schema: *436
examples:
- default: *441
+ default: *438
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61723,10 +61275,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment
parameters:
- - *432
- - *300
- - *299
- - *442
+ - *429
+ - *297
+ - *296
+ - *439
responses:
'204':
description: Response
@@ -61752,9 +61304,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-environment-secrets
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
- *4
- *5
responses:
@@ -61772,9 +61324,9 @@ paths:
type: integer
secrets:
type: array
- items: *336
+ items: *333
examples:
- default: *337
+ default: *334
headers:
Link: *6
x-github:
@@ -61799,17 +61351,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-public-key
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
responses:
'200':
description: Response
content:
application/json:
- schema: *338
+ schema: *335
examples:
- default: *339
+ default: *336
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61831,18 +61383,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-secret
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
- *168
responses:
'200':
description: Response
content:
application/json:
- schema: *336
+ schema: *333
examples:
- default: *443
+ default: *440
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -61864,9 +61416,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
- *168
requestBody:
required: true
@@ -61924,9 +61476,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-an-environment-secret
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
- *168
responses:
'204':
@@ -61952,10 +61504,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-environment-variables
parameters:
- - *299
- - *300
- - *432
- - *323
+ - *296
+ - *297
+ - *429
+ - *320
- *5
responses:
'200':
@@ -61972,9 +61524,9 @@ paths:
type: integer
variables:
type: array
- items: *340
+ items: *337
examples:
- default: *341
+ default: *338
headers:
Link: *6
x-github:
@@ -61997,9 +61549,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-an-environment-variable
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
requestBody:
required: true
content:
@@ -62051,18 +61603,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-an-environment-variable
parameters:
- - *299
- - *300
- - *432
+ - *296
+ - *297
+ - *429
- *171
responses:
'200':
description: Response
content:
application/json:
- schema: *340
+ schema: *337
examples:
- default: *444
+ default: *441
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62083,10 +61635,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-an-environment-variable
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *171
- - *432
+ - *429
requestBody:
required: true
content:
@@ -62128,10 +61680,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-an-environment-variable
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *171
- - *432
+ - *429
responses:
'204':
description: Response
@@ -62153,8 +61705,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-repository-events
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -62232,8 +61784,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/forks#list-forks
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: sort
description: The sort order. `stargazers` will sort by star count.
in: query
@@ -62392,8 +61944,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/forks#create-a-fork
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: false
content:
@@ -62425,9 +61977,9 @@ paths:
description: Response
content:
application/json:
- schema: *310
+ schema: *307
examples:
- default: *312
+ default: *309
'400': *34
'422': *35
'403': *43
@@ -62448,8 +62000,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/blobs#create-a-blob
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -62509,7 +62061,7 @@ paths:
schema:
oneOf:
- *143
- - *445
+ - *442
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -62534,8 +62086,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/blobs#get-a-blob
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: file_sha
in: path
required: true
@@ -62634,8 +62186,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/commits#create-a-commit
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -62744,7 +62296,7 @@ paths:
description: Response
content:
application/json:
- schema: &446
+ schema: &443
title: Git Commit
description: Low-level Git commit operations within a repository
type: object
@@ -62951,15 +62503,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/commits#get-a-commit-object
parameters:
- - *299
- - *300
- - *404
+ - *296
+ - *297
+ - *401
responses:
'200':
description: Response
content:
application/json:
- schema: *446
+ schema: *443
examples:
default:
value:
@@ -63012,9 +62564,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#list-matching-references
parameters:
- - *299
- - *300
- - &447
+ - *296
+ - *297
+ - &444
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.
@@ -63031,7 +62583,7 @@ paths:
application/json:
schema:
type: array
- items: &448
+ items: &445
title: Git Reference
description: Git references within a repository
type: object
@@ -63106,17 +62658,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference
parameters:
- - *299
- - *300
- - *447
+ - *296
+ - *297
+ - *444
responses:
'200':
description: Response
content:
application/json:
- schema: *448
+ schema: *445
examples:
- default: &449
+ default: &446
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
@@ -63145,8 +62697,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -63175,9 +62727,9 @@ paths:
description: Response
content:
application/json:
- schema: *448
+ schema: *445
examples:
- default: *449
+ default: *446
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
@@ -63203,9 +62755,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#update-a-reference
parameters:
- - *299
- - *300
- - *447
+ - *296
+ - *297
+ - *444
requestBody:
required: true
content:
@@ -63234,9 +62786,9 @@ paths:
description: Response
content:
application/json:
- schema: *448
+ schema: *445
examples:
- default: *449
+ default: *446
'422': *35
'409': *145
x-github:
@@ -63254,9 +62806,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/refs#delete-a-reference
parameters:
- - *299
- - *300
- - *447
+ - *296
+ - *297
+ - *444
responses:
'204':
description: Response
@@ -63311,8 +62863,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/tags#create-a-tag-object
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -63379,7 +62931,7 @@ paths:
description: Response
content:
application/json:
- schema: &451
+ schema: &448
title: Git Tag
description: Metadata for a Git tag
type: object
@@ -63430,7 +62982,7 @@ paths:
- sha
- type
- url
- verification: *450
+ verification: *447
required:
- sha
- url
@@ -63440,7 +62992,7 @@ paths:
- tag
- message
examples:
- default: &452
+ default: &449
value:
node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==
tag: v0.0.1
@@ -63510,8 +63062,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/tags#get-a-tag
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: tag_sha
in: path
required: true
@@ -63522,9 +63074,9 @@ paths:
description: Response
content:
application/json:
- schema: *451
+ schema: *448
examples:
- default: *452
+ default: *449
'404': *26
'409': *145
x-github:
@@ -63548,8 +63100,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/trees#create-a-tree
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -63622,7 +63174,7 @@ paths:
description: Response
content:
application/json:
- schema: &453
+ schema: &450
title: Git Tree
description: The hierarchy between files in a Git repository.
type: object
@@ -63718,8 +63270,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: tree_sha
description: The SHA1 value or ref (branch or tag) name of the tree.
in: path
@@ -63742,7 +63294,7 @@ paths:
description: Response
content:
application/json:
- schema: *453
+ schema: *450
examples:
default-response:
summary: Default response
@@ -63801,8 +63353,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-repository-webhooks
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -63812,7 +63364,7 @@ paths:
application/json:
schema:
type: array
- items: &454
+ items: &451
title: Webhook
description: Webhooks for repositories.
type: object
@@ -63866,7 +63418,7 @@ paths:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
- last_response: &653
+ last_response: &648
title: Hook Response
type: object
properties:
@@ -63940,8 +63492,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#create-a-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: false
content:
@@ -63993,9 +63545,9 @@ paths:
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: &455
+ default: &452
value:
type: Repository
id: 12345678
@@ -64043,17 +63595,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
responses:
'200':
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: *455
+ default: *452
'404': *26
x-github:
githubCloudOnly: false
@@ -64073,8 +63625,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
requestBody:
required: true
@@ -64120,9 +63672,9 @@ paths:
description: Response
content:
application/json:
- schema: *454
+ schema: *451
examples:
- default: *455
+ default: *452
'422': *35
'404': *26
x-github:
@@ -64143,8 +63695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#delete-a-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
responses:
'204':
@@ -64169,8 +63721,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
responses:
'200':
@@ -64198,8 +63750,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
requestBody:
required: false
@@ -64244,8 +63796,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-deliveries-for-a-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
- *4
- *207
@@ -64277,8 +63829,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
- *36
responses:
@@ -64307,8 +63859,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
- *36
responses:
@@ -64332,8 +63884,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#ping-a-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
responses:
'204':
@@ -64359,8 +63911,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#test-the-push-repository-webhook
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *3
responses:
'204':
@@ -64385,8 +63937,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -64394,8 +63946,8 @@ paths:
application/json:
schema: *39
examples:
- default: *456
- '301': *311
+ default: *453
+ '301': *308
'404': *26
x-github:
githubCloudOnly: false
@@ -64414,8 +63966,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#list-repository-invitations
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -64425,7 +63977,7 @@ paths:
application/json:
schema:
type: array
- items: &457
+ items: &454
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -64488,7 +64040,7 @@ paths:
- html_url
- created_at
examples:
- default: &602
+ default: &597
value:
- id: 1
repository:
@@ -64619,9 +64171,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- - *299
- - *300
- - &458
+ - *296
+ - *297
+ - &455
name: invitation_id
description: The unique identifier of the invitation.
in: path
@@ -64656,7 +64208,7 @@ paths:
description: Response
content:
application/json:
- schema: *457
+ schema: *454
examples:
default:
value:
@@ -64787,9 +64339,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#delete-a-repository-invitation
parameters:
- - *299
- - *300
- - *458
+ - *296
+ - *297
+ - *455
responses:
'204':
description: Response
@@ -64820,8 +64372,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#list-repository-issues
parameters:
- - *299
- - *300
+ - *296
+ - *297
- 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
@@ -65042,7 +64594,7 @@ paths:
state_reason: completed
headers:
Link: *6
- '301': *311
+ '301': *308
'422': *35
'404': *26
x-github:
@@ -65071,8 +64623,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#create-an-issue
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -65156,7 +64708,7 @@ paths:
application/json:
schema: *109
examples:
- default: &466
+ default: &463
value:
id: 1
node_id: MDU6SXNzdWUx
@@ -65340,9 +64892,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments-for-a-repository
parameters:
- - *299
- - *300
- - &508
+ - *296
+ - *297
+ - &505
name: sort
description: The property to sort the results by.
in: query
@@ -65372,9 +64924,9 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: &468
+ default: &465
value:
- id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -65432,17 +64984,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: &460
+ default: &457
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
@@ -65496,8 +65048,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#update-an-issue-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
requestBody:
required: true
@@ -65520,9 +65072,9 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
'422': *35
x-github:
githubCloudOnly: false
@@ -65540,8 +65092,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#delete-an-issue-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
responses:
'204':
@@ -65562,8 +65114,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -65590,9 +65142,9 @@ paths:
application/json:
schema:
type: array
- items: *401
+ items: *398
examples:
- default: *461
+ default: *458
headers:
Link: *6
'404': *26
@@ -65613,8 +65165,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
requestBody:
required: true
@@ -65647,16 +65199,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'201':
description: Reaction created
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'422': *35
x-github:
githubCloudOnly: false
@@ -65678,10 +65230,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-comment-reaction
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
- - *462
+ - *459
responses:
'204':
description: Response
@@ -65701,8 +65253,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -65712,7 +65264,7 @@ paths:
application/json:
schema:
type: array
- items: &465
+ items: &462
title: Issue Event
description: Issue Event
type: object
@@ -65755,8 +65307,8 @@ paths:
description: Issues are a great way to keep track of tasks,
enhancements, and bugs for your projects.
type: object
- properties: *463
- required: *464
+ properties: *460
+ required: *461
nullable: true
label:
title: Issue Event Label
@@ -65800,7 +65352,7 @@ paths:
properties: *17
required: *18
nullable: true
- requested_team: *301
+ requested_team: *298
dismissed_review:
title: Issue Event Dismissed Review
type: object
@@ -66063,8 +65615,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#get-an-issue-event
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: event_id
in: path
required: true
@@ -66075,7 +65627,7 @@ paths:
description: Response
content:
application/json:
- schema: *465
+ schema: *462
examples:
default:
value:
@@ -66301,9 +65853,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue
parameters:
- - *299
- - *300
- - &467
+ - *296
+ - *297
+ - &464
name: issue_number
description: The number that identifies the issue.
in: path
@@ -66317,8 +65869,8 @@ paths:
application/json:
schema: *109
examples:
- default: *466
- '301': *311
+ default: *463
+ '301': *308
'404': *26
'410': *243
'304': *42
@@ -66345,9 +65897,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#update-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
requestBody:
required: false
content:
@@ -66453,11 +66005,11 @@ paths:
application/json:
schema: *109
examples:
- default: *466
+ default: *463
'422': *35
'503': *104
'403': *43
- '301': *311
+ '301': *308
'404': *26
'410': *243
x-github:
@@ -66477,9 +66029,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#add-assignees-to-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
requestBody:
required: false
content:
@@ -66507,7 +66059,7 @@ paths:
application/json:
schema: *109
examples:
- default: *466
+ default: *463
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66523,9 +66075,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#remove-assignees-from-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
requestBody:
content:
application/json:
@@ -66552,7 +66104,7 @@ paths:
application/json:
schema: *109
examples:
- default: *466
+ default: *463
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -66574,9 +66126,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
- name: assignee
in: path
required: true
@@ -66616,9 +66168,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
- *119
- *4
- *5
@@ -66629,9 +66181,9 @@ paths:
application/json:
schema:
type: array
- items: *459
+ items: *456
examples:
- default: *468
+ default: *465
headers:
Link: *6
'404': *26
@@ -66664,9 +66216,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/comments#create-an-issue-comment
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
requestBody:
required: true
content:
@@ -66688,9 +66240,9 @@ paths:
description: Response
content:
application/json:
- schema: *459
+ schema: *456
examples:
- default: *460
+ default: *457
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
@@ -66717,9 +66269,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
- *4
- *5
responses:
@@ -66733,7 +66285,7 @@ paths:
title: Issue Event for Issue
description: Issue Event for Issue
anyOf:
- - &470
+ - &467
title: Labeled Issue Event
description: Labeled Issue Event
type: object
@@ -66787,7 +66339,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &471
+ - &468
title: Unlabeled Issue Event
description: Unlabeled Issue Event
type: object
@@ -66923,7 +66475,7 @@ paths:
- performed_via_github_app
- assignee
- assigner
- - &472
+ - &469
title: Milestoned Issue Event
description: Milestoned Issue Event
type: object
@@ -66974,7 +66526,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &473
+ - &470
title: Demilestoned Issue Event
description: Demilestoned Issue Event
type: object
@@ -67025,7 +66577,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &474
+ - &471
title: Renamed Issue Event
description: Renamed Issue Event
type: object
@@ -67079,7 +66631,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &475
+ - &472
title: Review Requested Issue Event
description: Review Requested Issue Event
type: object
@@ -67113,7 +66665,7 @@ paths:
properties: *106
required: *107
review_requester: *19
- requested_team: *301
+ requested_team: *298
requested_reviewer: *19
required:
- review_requester
@@ -67126,7 +66678,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &476
+ - &473
title: Review Request Removed Issue Event
description: Review Request Removed Issue Event
type: object
@@ -67160,7 +66712,7 @@ paths:
properties: *106
required: *107
review_requester: *19
- requested_team: *301
+ requested_team: *298
requested_reviewer: *19
required:
- review_requester
@@ -67173,7 +66725,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &477
+ - &474
title: Review Dismissed Issue Event
description: Review Dismissed Issue Event
type: object
@@ -67233,7 +66785,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &478
+ - &475
title: Locked Issue Event
description: Locked Issue Event
type: object
@@ -67281,7 +66833,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &479
+ - &476
title: Added to Project Issue Event
description: Added to Project Issue Event
type: object
@@ -67347,7 +66899,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &480
+ - &477
title: Moved Column in Project Issue Event
description: Moved Column in Project Issue Event
type: object
@@ -67413,7 +66965,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &481
+ - &478
title: Removed from Project Issue Event
description: Removed from Project Issue Event
type: object
@@ -67479,7 +67031,7 @@ paths:
- commit_url
- created_at
- performed_via_github_app
- - &482
+ - &479
title: Converted Note to Issue Issue Event
description: Converted Note to Issue Issue Event
type: object
@@ -67587,9 +67139,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
- *4
- *5
responses:
@@ -67601,7 +67153,7 @@ paths:
type: array
items: *108
examples:
- default: &469
+ default: &466
value:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -67619,7 +67171,7 @@ paths:
default: false
headers:
Link: *6
- '301': *311
+ '301': *308
'404': *26
'410': *243
x-github:
@@ -67638,9 +67190,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#add-labels-to-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
requestBody:
required: false
content:
@@ -67701,8 +67253,8 @@ paths:
type: array
items: *108
examples:
- default: *469
- '301': *311
+ default: *466
+ '301': *308
'404': *26
'410': *243
'422': *35
@@ -67721,9 +67273,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#set-labels-for-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
requestBody:
required: false
content:
@@ -67785,8 +67337,8 @@ paths:
type: array
items: *108
examples:
- default: *469
- '301': *311
+ default: *466
+ '301': *308
'404': *26
'410': *243
'422': *35
@@ -67805,13 +67357,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#remove-all-labels-from-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
responses:
'204':
description: Response
- '301': *311
+ '301': *308
'404': *26
'410': *243
x-github:
@@ -67832,9 +67384,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#remove-a-label-from-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
- name: name
in: path
required: true
@@ -67858,7 +67410,7 @@ paths:
description: Something isn't working
color: f29513
default: true
- '301': *311
+ '301': *308
'404': *26
'410': *243
x-github:
@@ -67880,9 +67432,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#lock-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
requestBody:
required: false
content:
@@ -67928,9 +67480,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/issues#unlock-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
responses:
'204':
description: Response
@@ -67952,9 +67504,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to an issue.
@@ -67980,9 +67532,9 @@ paths:
application/json:
schema:
type: array
- items: *401
+ items: *398
examples:
- default: *461
+ default: *458
headers:
Link: *6
'404': *26
@@ -68004,9 +67556,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
requestBody:
required: true
content:
@@ -68038,16 +67590,16 @@ paths:
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'201':
description: Response
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'422': *35
x-github:
githubCloudOnly: false
@@ -68069,10 +67621,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-reaction
parameters:
- - *299
- - *300
- - *467
- - *462
+ - *296
+ - *297
+ - *464
+ - *459
responses:
'204':
description: Response
@@ -68092,9 +67644,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- - *299
- - *300
- - *467
+ - *296
+ - *297
+ - *464
- *4
- *5
responses:
@@ -68109,6 +67661,9 @@ paths:
description: Timeline Event
type: object
anyOf:
+ - *467
+ - *468
+ - *469
- *470
- *471
- *472
@@ -68119,9 +67674,6 @@ paths:
- *477
- *478
- *479
- - *480
- - *481
- - *482
- title: Timeline Comment Event
description: Timeline Comment Event
type: object
@@ -68426,7 +67978,7 @@ paths:
type: string
comments:
type: array
- items: &504
+ items: &501
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on
a portion of the Pull Request's diff.
@@ -68641,7 +68193,7 @@ paths:
type: string
comments:
type: array
- items: *400
+ items: *397
- title: Timeline Assigned Issue Event
description: Timeline Assigned Issue Event
type: object
@@ -68947,8 +68499,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#list-deploy-keys
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -68958,7 +68510,7 @@ paths:
application/json:
schema:
type: array
- items: &483
+ items: &480
title: Deploy Key
description: An SSH key granting access to a single repository.
type: object
@@ -69022,8 +68574,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#create-a-deploy-key
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -69059,9 +68611,9 @@ paths:
description: Response
content:
application/json:
- schema: *483
+ schema: *480
examples:
- default: &484
+ default: &481
value:
id: 1
key: ssh-rsa AAA...
@@ -69094,9 +68646,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key
parameters:
- - *299
- - *300
- - &485
+ - *296
+ - *297
+ - &482
name: key_id
description: The unique identifier of the key.
in: path
@@ -69108,9 +68660,9 @@ paths:
description: Response
content:
application/json:
- schema: *483
+ schema: *480
examples:
- default: *484
+ default: *481
'404': *26
x-github:
githubCloudOnly: false
@@ -69128,9 +68680,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#delete-a-deploy-key
parameters:
- - *299
- - *300
- - *485
+ - *296
+ - *297
+ - *482
responses:
'204':
description: Response
@@ -69150,8 +68702,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -69163,7 +68715,7 @@ paths:
type: array
items: *108
examples:
- default: *469
+ default: *466
headers:
Link: *6
'404': *26
@@ -69184,8 +68736,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#create-a-label
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -69223,7 +68775,7 @@ paths:
application/json:
schema: *108
examples:
- default: &486
+ default: &483
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
@@ -69255,8 +68807,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#get-a-label
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: name
in: path
required: true
@@ -69269,7 +68821,7 @@ paths:
application/json:
schema: *108
examples:
- default: *486
+ default: *483
'404': *26
x-github:
githubCloudOnly: false
@@ -69286,8 +68838,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#update-a-label
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: name
in: path
required: true
@@ -69352,8 +68904,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#delete-a-label
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: name
in: path
required: true
@@ -69379,8 +68931,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-languages
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -69416,8 +68968,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#enable-git-lfs-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'202': *146
'403':
@@ -69445,8 +68997,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#disable-git-lfs-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -69472,9 +69024,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/licenses/licenses#get-the-license-for-a-repository
parameters:
- - *299
- - *300
- - *388
+ - *296
+ - *297
+ - *385
responses:
'200':
description: Response
@@ -69619,8 +69171,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -69685,8 +69237,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/branches/branches#merge-a-branch
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -69720,9 +69272,9 @@ paths:
description: Successful Response (The resulting merge commit)
content:
application/json:
- schema: *403
+ schema: *400
examples:
- default: *487
+ default: *484
'204':
description: Response when already merged
'404':
@@ -69747,8 +69299,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#list-milestones
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: state
description: The state of the milestone. Either `open`, `closed`, or `all`.
in: query
@@ -69789,7 +69341,7 @@ paths:
application/json:
schema:
type: array
- items: &488
+ items: &485
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -69850,8 +69402,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#create-a-milestone
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -69891,9 +69443,9 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
- default: &489
+ default: &486
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
@@ -69952,9 +69504,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#get-a-milestone
parameters:
- - *299
- - *300
- - &490
+ - *296
+ - *297
+ - &487
name: milestone_number
description: The number that identifies the milestone.
in: path
@@ -69966,9 +69518,9 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
- default: *489
+ default: *486
'404': *26
x-github:
githubCloudOnly: false
@@ -69985,9 +69537,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#update-a-milestone
parameters:
- - *299
- - *300
- - *490
+ - *296
+ - *297
+ - *487
requestBody:
required: false
content:
@@ -70025,9 +69577,9 @@ paths:
description: Response
content:
application/json:
- schema: *488
+ schema: *485
examples:
- default: *489
+ default: *486
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -70043,9 +69595,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#delete-a-milestone
parameters:
- - *299
- - *300
- - *490
+ - *296
+ - *297
+ - *487
responses:
'204':
description: Response
@@ -70066,9 +69618,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-issues-in-a-milestone
parameters:
- - *299
- - *300
- - *490
+ - *296
+ - *297
+ - *487
- *4
- *5
responses:
@@ -70080,7 +69632,7 @@ paths:
type: array
items: *108
examples:
- default: *469
+ default: *466
headers:
Link: *6
x-github:
@@ -70099,12 +69651,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user
parameters:
- - *299
- - *300
- - *491
- - *492
+ - *296
+ - *297
+ - *488
+ - *489
- *119
- - *493
+ - *490
- *4
- *5
responses:
@@ -70116,7 +69668,7 @@ paths:
type: array
items: *136
examples:
- default: *494
+ default: *491
headers:
Link: *6
x-github:
@@ -70140,8 +69692,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#mark-repository-notifications-as-read
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: false
content:
@@ -70199,14 +69751,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-a-apiname-pages-site
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: &495
+ schema: &492
title: GitHub Pages
description: The configuration for GitHub Pages for a repository.
type: object
@@ -70331,7 +69883,7 @@ paths:
- custom_404
- public
examples:
- default: &496
+ default: &493
value:
url: https://api.github.com/repos/github/developer.github.com/pages
status: built
@@ -70372,8 +69924,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-apiname-pages-site
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -70427,9 +69979,9 @@ paths:
description: Response
content:
application/json:
- schema: *495
+ schema: *492
examples:
- default: *496
+ default: *493
'422': *35
'409': *145
x-github:
@@ -70452,8 +70004,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -70552,8 +70104,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#delete-a-apiname-pages-site
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -70579,8 +70131,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#list-apiname-pages-builds
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -70590,7 +70142,7 @@ paths:
application/json:
schema:
type: array
- items: &497
+ items: &494
title: Page Build
description: Page Build
type: object
@@ -70684,8 +70236,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#request-a-apiname-pages-build
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'201':
description: Response
@@ -70730,16 +70282,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-latest-pages-build
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: &498
+ default: &495
value:
url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601
status: built
@@ -70787,8 +70339,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-apiname-pages-build
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: build_id
in: path
required: true
@@ -70799,9 +70351,9 @@ paths:
description: Response
content:
application/json:
- schema: *497
+ schema: *494
examples:
- default: *498
+ default: *495
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -70821,8 +70373,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-github-pages-deployment
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -70922,9 +70474,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-the-status-of-a-github-pages-deployment
parameters:
- - *299
- - *300
- - &499
+ - *296
+ - *297
+ - &496
name: pages_deployment_id
description: The ID of the Pages deployment. You can also give the commit
SHA of the deployment.
@@ -70982,9 +70534,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pages/pages#cancel-a-github-pages-deployment
parameters:
- - *299
- - *300
- - *499
+ - *296
+ - *297
+ - *496
responses:
'204': *239
'404': *26
@@ -71007,8 +70559,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
- *9
@@ -71029,7 +70581,7 @@ paths:
application/json:
schema:
type: array
- items: &500
+ items: &497
type: object
properties:
id:
@@ -71063,17 +70615,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *500
+ schema: *497
examples:
- default: &501
+ default: &498
value:
id: 42
name: Check Commits
@@ -71095,15 +70647,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *16
responses:
'200':
description: Response
content:
application/json:
- schema: *500
+ schema: *497
examples:
default:
value:
@@ -71147,8 +70699,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *16
responses:
'200':
@@ -71156,9 +70708,9 @@ paths:
global level.
content:
application/json:
- schema: *500
+ schema: *497
examples:
- default: *501
+ default: *498
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -71178,8 +70730,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#list-repository-projects
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: state
description: Indicates the state of the projects to return.
in: query
@@ -71264,8 +70816,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#create-a-repository-project
deprecated: true
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -71293,7 +70845,7 @@ paths:
application/json:
schema: *242
examples:
- default: *308
+ default: *305
'401': *41
'403': *43
'404': *26
@@ -71317,8 +70869,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -71357,8 +70909,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -71420,8 +70972,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: state
description: Either `open`, `closed`, or `all` to filter by state.
in: query
@@ -71481,9 +71033,9 @@ paths:
application/json:
schema:
type: array
- items: *502
+ items: *499
examples:
- default: *503
+ default: *500
headers:
Link: *6
'304': *42
@@ -71515,8 +71067,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#create-a-pull-request
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -71583,7 +71135,7 @@ paths:
application/json:
schema: *117
examples:
- default: &506
+ default: &503
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
@@ -72110,8 +71662,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#list-review-comments-in-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: sort
in: query
required: false
@@ -72140,9 +71692,9 @@ paths:
application/json:
schema:
type: array
- items: *504
+ items: *501
examples:
- default: &509
+ default: &506
value:
- url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -72219,17 +71771,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
responses:
'200':
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
- default: &505
+ default: &502
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
@@ -72304,8 +71856,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
requestBody:
required: true
@@ -72328,9 +71880,9 @@ paths:
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
- default: *505
+ default: *502
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -72346,8 +71898,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#delete-a-review-comment-for-a-pull-request
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
responses:
'204':
@@ -72369,8 +71921,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
@@ -72397,9 +71949,9 @@ paths:
application/json:
schema:
type: array
- items: *401
+ items: *398
examples:
- default: *461
+ default: *458
headers:
Link: *6
'404': *26
@@ -72420,8 +71972,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
requestBody:
required: true
@@ -72454,16 +72006,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'201':
description: Reaction created
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'422': *35
x-github:
githubCloudOnly: false
@@ -72485,10 +72037,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-pull-request-comment-reaction
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *128
- - *462
+ - *459
responses:
'204':
description: Response
@@ -72531,9 +72083,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request
parameters:
- - *299
- - *300
- - &507
+ - *296
+ - *297
+ - &504
name: pull_number
description: The number that identifies the pull request.
in: path
@@ -72548,7 +72100,7 @@ paths:
application/json:
schema: *117
examples:
- default: *506
+ default: *503
'304': *42
'404': *26
'406':
@@ -72583,9 +72135,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
requestBody:
required: false
content:
@@ -72629,7 +72181,7 @@ paths:
application/json:
schema: *117
examples:
- default: *506
+ default: *503
'422': *35
'403': *43
x-github:
@@ -72657,10 +72209,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#list-review-comments-on-a-pull-request
parameters:
- - *299
- - *300
- - *507
- - *508
+ - *296
+ - *297
+ - *504
+ - *505
- name: direction
description: The direction to sort results. Ignored without `sort` parameter.
in: query
@@ -72680,9 +72232,9 @@ paths:
application/json:
schema:
type: array
- items: *504
+ items: *501
examples:
- default: *509
+ default: *506
headers:
Link: *6
x-github:
@@ -72715,9 +72267,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#create-a-review-comment-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
requestBody:
required: true
content:
@@ -72822,7 +72374,7 @@ paths:
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
example-for-a-multi-line-comment:
value:
@@ -72910,9 +72462,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#create-a-reply-for-a-review-comment
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
- *128
requestBody:
required: true
@@ -72935,7 +72487,7 @@ paths:
description: Response
content:
application/json:
- schema: *504
+ schema: *501
examples:
default:
value:
@@ -73021,9 +72573,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-commits-on-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
- *4
- *5
responses:
@@ -73033,9 +72585,9 @@ paths:
application/json:
schema:
type: array
- items: *403
+ items: *400
examples:
- default: *510
+ default: *507
headers:
Link: *6
x-github:
@@ -73065,9 +72617,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests-files
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
- *4
- *5
responses:
@@ -73077,7 +72629,7 @@ paths:
application/json:
schema:
type: array
- items: *412
+ items: *409
examples:
default:
value:
@@ -73115,9 +72667,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#check-if-a-pull-request-has-been-merged
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
responses:
'204':
description: Response if pull request has been merged
@@ -73140,9 +72692,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#merge-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
requestBody:
required: false
content:
@@ -73253,9 +72805,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
responses:
'200':
description: Response
@@ -73271,7 +72823,7 @@ paths:
items: *19
teams:
type: array
- items: *301
+ items: *298
required:
- users
- teams
@@ -73330,9 +72882,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#request-reviewers-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
requestBody:
required: false
content:
@@ -73369,7 +72921,7 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
default:
value:
@@ -73905,9 +73457,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
requestBody:
required: true
content:
@@ -73941,7 +73493,7 @@ paths:
description: Response
content:
application/json:
- schema: *502
+ schema: *499
examples:
default:
value:
@@ -74446,9 +73998,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-reviews-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
- *4
- *5
responses:
@@ -74458,7 +74010,7 @@ paths:
application/json:
schema:
type: array
- items: &511
+ items: &508
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
@@ -74609,9 +74161,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#create-a-review-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
requestBody:
required: false
content:
@@ -74697,9 +74249,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: &513
+ default: &510
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -74762,10 +74314,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#get-a-review-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
- - &512
+ - *296
+ - *297
+ - *504
+ - &509
name: review_id
description: The unique identifier of the review.
in: path
@@ -74777,9 +74329,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: &514
+ default: &511
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -74838,10 +74390,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
- - *512
+ - *296
+ - *297
+ - *504
+ - *509
requestBody:
required: true
content:
@@ -74864,7 +74416,7 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
default:
value:
@@ -74926,18 +74478,18 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
- - *512
+ - *296
+ - *297
+ - *504
+ - *509
responses:
'200':
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: *513
+ default: *510
'422': *27
'404': *26
x-github:
@@ -74964,10 +74516,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-comments-for-a-pull-request-review
parameters:
- - *299
- - *300
- - *507
- - *512
+ - *296
+ - *297
+ - *504
+ - *509
- *4
- *5
responses:
@@ -75202,10 +74754,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#dismiss-a-review-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
- - *512
+ - *296
+ - *297
+ - *504
+ - *509
requestBody:
required: true
content:
@@ -75233,7 +74785,7 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
default:
value:
@@ -75296,10 +74848,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request
parameters:
- - *299
- - *300
- - *507
- - *512
+ - *296
+ - *297
+ - *504
+ - *509
requestBody:
required: true
content:
@@ -75334,9 +74886,9 @@ paths:
description: Response
content:
application/json:
- schema: *511
+ schema: *508
examples:
- default: *514
+ default: *511
'404': *26
'422': *27
'403': *43
@@ -75358,9 +74910,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- - *299
- - *300
- - *507
+ - *296
+ - *297
+ - *504
requestBody:
required: false
content:
@@ -75423,8 +74975,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: ref
description: 'The name of the commit/branch/tag. Default: the repository’s
default branch.'
@@ -75437,9 +74989,9 @@ paths:
description: Response
content:
application/json:
- schema: *515
+ schema: *512
examples:
- default: &516
+ default: &513
value:
type: file
encoding: base64
@@ -75481,8 +75033,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme-for-a-directory
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: dir
description: The alternate path to look for a README file
in: path
@@ -75502,9 +75054,9 @@ paths:
description: Response
content:
application/json:
- schema: *515
+ schema: *512
examples:
- default: *516
+ default: *513
'404': *26
'422': *35
x-github:
@@ -75526,8 +75078,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#list-releases
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -75537,7 +75089,7 @@ paths:
application/json:
schema:
type: array
- items: *517
+ items: *514
examples:
default:
value:
@@ -75631,8 +75183,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#create-a-release
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -75702,9 +75254,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: &522
+ default: &519
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
@@ -75804,9 +75356,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#get-a-release-asset
parameters:
- - *299
- - *300
- - &520
+ - *296
+ - *297
+ - &517
name: asset_id
description: The unique identifier of the asset.
in: path
@@ -75818,9 +75370,9 @@ paths:
description: Response
content:
application/json:
- schema: *518
+ schema: *515
examples:
- default: &521
+ default: &518
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1
browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip
@@ -75855,7 +75407,7 @@ paths:
type: User
site_admin: false
'404': *26
- '302': *519
+ '302': *516
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75871,9 +75423,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#update-a-release-asset
parameters:
- - *299
- - *300
- - *520
+ - *296
+ - *297
+ - *517
requestBody:
required: false
content:
@@ -75901,9 +75453,9 @@ paths:
description: Response
content:
application/json:
- schema: *518
+ schema: *515
examples:
- default: *521
+ default: *518
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -75919,9 +75471,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#delete-a-release-asset
parameters:
- - *299
- - *300
- - *520
+ - *296
+ - *297
+ - *517
responses:
'204':
description: Response
@@ -75945,8 +75497,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#generate-release-notes-content-for-a-release
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -76031,16 +75583,16 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-the-latest-release
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *522
+ default: *519
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76057,8 +75609,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release-by-tag-name
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: tag
description: tag parameter
in: path
@@ -76071,9 +75623,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *522
+ default: *519
'404': *26
x-github:
githubCloudOnly: false
@@ -76095,9 +75647,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release
parameters:
- - *299
- - *300
- - &523
+ - *296
+ - *297
+ - &520
name: release_id
description: The unique identifier of the release.
in: path
@@ -76111,9 +75663,9 @@ paths:
For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."'
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *522
+ default: *519
'401':
description: Unauthorized
x-github:
@@ -76131,9 +75683,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#update-a-release
parameters:
- - *299
- - *300
- - *523
+ - *296
+ - *297
+ - *520
requestBody:
required: false
content:
@@ -76190,9 +75742,9 @@ paths:
description: Response
content:
application/json:
- schema: *517
+ schema: *514
examples:
- default: *522
+ default: *519
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
@@ -76208,9 +75760,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/releases#delete-a-release
parameters:
- - *299
- - *300
- - *523
+ - *296
+ - *297
+ - *520
responses:
'204':
description: Response
@@ -76230,9 +75782,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets
parameters:
- - *299
- - *300
- - *523
+ - *296
+ - *297
+ - *520
- *4
- *5
responses:
@@ -76242,7 +75794,7 @@ paths:
application/json:
schema:
type: array
- items: *518
+ items: *515
examples:
default:
value:
@@ -76324,9 +75876,9 @@ paths:
description: The URL origin (protocol + host name + port) is included in `upload_url`
returned in the response of the "Create a release" endpoint
parameters:
- - *299
- - *300
- - *523
+ - *296
+ - *297
+ - *520
- name: name
in: query
required: true
@@ -76352,7 +75904,7 @@ paths:
description: Response for successful upload
content:
application/json:
- schema: *518
+ schema: *515
examples:
response-for-successful-upload:
value:
@@ -76407,9 +75959,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-release
parameters:
- - *299
- - *300
- - *523
+ - *296
+ - *297
+ - *520
- name: content
description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions).
Omit this parameter to list all reactions to a release.
@@ -76433,9 +75985,9 @@ paths:
application/json:
schema:
type: array
- items: *401
+ items: *398
examples:
- default: *461
+ default: *458
headers:
Link: *6
'404': *26
@@ -76456,9 +76008,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-release
parameters:
- - *299
- - *300
- - *523
+ - *296
+ - *297
+ - *520
requestBody:
required: true
content:
@@ -76488,16 +76040,16 @@ paths:
description: Reaction exists
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'201':
description: Reaction created
content:
application/json:
- schema: *401
+ schema: *398
examples:
- default: *402
+ default: *399
'422': *35
x-github:
githubCloudOnly: false
@@ -76519,10 +76071,10 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-release-reaction
parameters:
- - *299
- - *300
- - *523
- - *462
+ - *296
+ - *297
+ - *520
+ - *459
responses:
'204':
description: Response
@@ -76542,8 +76094,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-cache-replication-status
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -76618,9 +76170,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-rules-for-a-branch
parameters:
- - *299
- - *300
- - *357
+ - *296
+ - *297
+ - *354
- *4
- *5
responses:
@@ -76637,7 +76189,7 @@ paths:
oneOf:
- allOf:
- *257
- - &524
+ - &521
title: repository ruleset data for rule
description: User-defined metadata to store domain-specific
information limited to 8 keys with scalar values.
@@ -76658,49 +76210,49 @@ paths:
description: The ID of the ruleset that includes this rule.
- allOf:
- *258
- - *524
+ - *521
- allOf:
- *259
- - *524
+ - *521
- allOf:
- *260
- - *524
+ - *521
- allOf:
- *261
- - *524
+ - *521
- allOf:
- *262
- - *524
+ - *521
- allOf:
- *263
- - *524
+ - *521
- allOf:
- *264
- - *524
+ - *521
- allOf:
- *265
- - *524
+ - *521
- allOf:
- *266
- - *524
+ - *521
- allOf:
- *267
- - *524
+ - *521
- allOf:
- *268
- - *524
+ - *521
- allOf:
- *269
- - *524
+ - *521
- allOf:
- *270
- - *524
+ - *521
- allOf:
- *271
- - *524
+ - *521
- allOf:
- *272
- - *524
+ - *521
examples:
default:
value:
@@ -76739,8 +76291,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
- name: includes_parents
@@ -76751,7 +76303,7 @@ paths:
schema:
type: boolean
default: true
- - *525
+ - *522
responses:
'200':
description: Response
@@ -76806,8 +76358,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
description: Request body
required: true
@@ -76836,7 +76388,7 @@ paths:
rules:
type: array
description: An array of rules within the ruleset.
- items: *526
+ items: *523
required:
- name
- enforcement
@@ -76869,7 +76421,7 @@ paths:
application/json:
schema: *273
examples:
- default: &536
+ default: &533
value:
id: 42
name: super cool ruleset
@@ -76916,12 +76468,12 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rule-suites#list-repository-rule-suites
parameters:
- - *299
- - *300
+ - *296
+ - *297
+ - *524
+ - *525
+ - *526
- *527
- - *528
- - *529
- - *530
- *4
- *5
responses:
@@ -76929,9 +76481,9 @@ paths:
description: Response
content:
application/json:
- schema: *531
+ schema: *528
examples:
- default: *532
+ default: *529
'404': *26
'500': *230
x-github:
@@ -76952,17 +76504,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/rule-suites#get-a-repository-rule-suite
parameters:
- - *299
- - *300
- - *533
+ - *296
+ - *297
+ - *530
responses:
'200':
description: Response
content:
application/json:
- schema: *534
+ schema: *531
examples:
- default: *535
+ default: *532
'404': *26
'500': *230
x-github:
@@ -76990,8 +76542,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77013,7 +76565,7 @@ paths:
application/json:
schema: *273
examples:
- default: *536
+ default: *533
'404': *26
'500': *230
put:
@@ -77031,8 +76583,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77066,7 +76618,7 @@ paths:
rules:
description: An array of rules within the ruleset.
type: array
- items: *526
+ items: *523
examples:
default:
value:
@@ -77096,7 +76648,7 @@ paths:
application/json:
schema: *273
examples:
- default: *536
+ default: *533
'404': *26
'500': *230
delete:
@@ -77114,8 +76666,8 @@ paths:
category: repos
subcategory: rules
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: ruleset_id
description: The ID of the ruleset.
in: path
@@ -77143,8 +76695,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *276
- *277
- *278
@@ -77152,8 +76704,8 @@ paths:
- *9
- *5
- *4
- - *537
- - *538
+ - *534
+ - *535
- *280
responses:
'200':
@@ -77162,7 +76714,7 @@ paths:
application/json:
schema:
type: array
- items: &541
+ items: &538
type: object
properties:
number: *93
@@ -77181,8 +76733,8 @@ paths:
format: uri
description: The REST API URL of the code locations for this
alert.
- state: *539
- resolution: *540
+ state: *536
+ resolution: *537
resolved_at:
type: string
format: date-time
@@ -77360,15 +76912,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert
parameters:
- - *299
- - *300
- - *386
+ - *296
+ - *297
+ - *383
responses:
'200':
description: Response
content:
application/json:
- schema: *541
+ schema: *538
examples:
default:
value:
@@ -77408,9 +76960,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- - *299
- - *300
- - *386
+ - *296
+ - *297
+ - *383
requestBody:
required: true
content:
@@ -77418,8 +76970,8 @@ paths:
schema:
type: object
properties:
- state: *539
- resolution: *540
+ state: *536
+ resolution: *537
resolution_comment:
description: An optional comment when closing an alert. Cannot be
updated or deleted. Must be `null` when changing `state` to `open`.
@@ -77438,7 +76990,7 @@ paths:
description: Response
content:
application/json:
- schema: *541
+ schema: *538
examples:
default:
value:
@@ -77505,9 +77057,9 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert
parameters:
- - *299
- - *300
- - *386
+ - *296
+ - *297
+ - *383
- *5
- *4
responses:
@@ -77518,7 +77070,7 @@ paths:
schema:
type: array
description: List of locations where the secret was detected
- items: &673
+ items: &668
type: object
properties:
type:
@@ -77877,8 +77429,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-stargazers
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -77974,8 +77526,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-activity
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Returns a weekly aggregate of the number of additions and deletions
@@ -77984,7 +77536,7 @@ paths:
application/json:
schema:
type: array
- items: &542
+ items: &539
title: Code Frequency Stat
description: Code Frequency Stat
type: array
@@ -78015,8 +77567,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-last-year-of-commit-activity
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -78089,8 +77641,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-all-contributor-commit-activity
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -78186,8 +77738,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-count
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: The array order is oldest week (index 0) to most recent week.
@@ -78341,8 +77893,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: For example, `[2, 14, 25]` indicates that there were 25 total
@@ -78352,7 +77904,7 @@ paths:
application/json:
schema:
type: array
- items: *542
+ items: *539
examples:
default:
value:
@@ -78385,8 +77937,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#create-a-commit-status
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: sha
in: path
required: true
@@ -78440,7 +77992,7 @@ paths:
description: Response
content:
application/json:
- schema: *543
+ schema: *540
examples:
default:
value:
@@ -78494,8 +78046,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#list-watchers
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -78527,14 +78079,14 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#get-a-repository-subscription
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: if you subscribe to the repository
content:
application/json:
- schema: &544
+ schema: &541
title: Repository Invitation
description: Repository invitations let you manage who you collaborate
with.
@@ -78602,8 +78154,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: false
content:
@@ -78629,7 +78181,7 @@ paths:
description: Response
content:
application/json:
- schema: *544
+ schema: *541
examples:
default:
value:
@@ -78656,8 +78208,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/watching#delete-a-repository-subscription
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -78677,8 +78229,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-tags
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -78757,8 +78309,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Response
@@ -78766,7 +78318,7 @@ paths:
application/json:
schema:
type: array
- items: &545
+ items: &542
title: Tag protection
description: Tag protection
type: object
@@ -78818,8 +78370,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -78842,7 +78394,7 @@ paths:
description: Response
content:
application/json:
- schema: *545
+ schema: *542
examples:
default:
value:
@@ -78873,8 +78425,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: tag_protection_id
description: The unique identifier of the tag protection.
in: path
@@ -78911,8 +78463,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#download-a-repository-archive-tar
operationId: repos/download-tarball-archive
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: ref
in: path
required: true
@@ -78948,8 +78500,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-teams
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *4
- *5
responses:
@@ -78959,7 +78511,7 @@ paths:
application/json:
schema:
type: array
- items: *301
+ items: *298
examples:
default: *283
headers:
@@ -78981,8 +78533,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-all-repository-topics
parameters:
- - *299
- - *300
+ - *296
+ - *297
- *5
- *4
responses:
@@ -78990,7 +78542,7 @@ paths:
description: Response
content:
application/json:
- schema: &546
+ schema: &543
title: Topic
description: A topic aggregates entities that are related to a subject.
type: object
@@ -79002,7 +78554,7 @@ paths:
required:
- names
examples:
- default: &547
+ default: &544
value:
names:
- octocat
@@ -79025,8 +78577,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -79057,9 +78609,9 @@ paths:
description: Response
content:
application/json:
- schema: *546
+ schema: *543
examples:
- default: *547
+ default: *544
'404': *26
'422': *27
x-github:
@@ -79082,8 +78634,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#transfer-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: true
content:
@@ -79357,8 +78909,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response if repository is enabled with vulnerability alerts
@@ -79381,8 +78933,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#enable-vulnerability-alerts
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -79404,8 +78956,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#disable-vulnerability-alerts
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -79431,8 +78983,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/repos/contents#download-a-repository-archive-zip
operationId: repos/download-zipball-archive
parameters:
- - *299
- - *300
+ - *296
+ - *297
- name: ref
in: path
required: true
@@ -79524,9 +79076,9 @@ paths:
description: Response
content:
application/json:
- schema: *310
+ schema: *307
examples:
- default: *312
+ default: *309
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -79700,7 +79252,7 @@ paths:
value: Engineering
externalId:
value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
- - &555
+ - &552
name: excludedAttributes
description: Excludes the specified attribute from being returned in the results.
Using this parameter can speed up response time.
@@ -79709,7 +79261,7 @@ paths:
schema:
type: string
example: members
- - &560
+ - &557
name: startIndex
description: 'Used for pagination: the starting index of the first result
to return when paginating through values.'
@@ -79720,7 +79272,7 @@ paths:
default: 1
format: int32
example: 1
- - &561
+ - &558
name: count
description: 'Used for pagination: the number of results to return per page.'
in: query
@@ -79762,7 +79314,7 @@ paths:
Resources:
type: array
description: Information about each provisioned group.
- items: &549
+ items: &546
allOf:
- type: object
required:
@@ -79837,7 +79389,7 @@ paths:
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
"$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
- meta: &562
+ meta: &559
type: object
description: The metadata associated with the creation/updates
to the user.
@@ -79897,31 +79449,31 @@ paths:
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
startIndex: 1
itemsPerPage: 20
- '400': &550
+ '400': &547
description: Bad request
content:
application/json:
- schema: *548
+ schema: *545
application/scim+json:
- schema: *548
- '401': &551
+ schema: *545
+ '401': &548
description: Authorization failure
- '403': &552
+ '403': &549
description: Permission denied
- '429': &553
+ '429': &550
description: Too many requests
content:
application/json:
- schema: *548
+ schema: *545
application/scim+json:
- schema: *548
- '500': &554
+ schema: *545
+ '500': &551
description: Internal server error
content:
application/json:
- schema: *548
+ schema: *545
application/scim+json:
- schema: *548
+ schema: *545
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -79948,7 +79500,7 @@ paths:
required: true
content:
application/json:
- schema: &558
+ schema: &555
type: object
required:
- schemas
@@ -80008,9 +79560,9 @@ paths:
description: Group has been created
content:
application/scim+json:
- schema: *549
+ schema: *546
examples:
- group: &556
+ group: &553
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
@@ -80029,13 +79581,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155
- '400': *550
- '401': *551
- '403': *552
- '409': &559
+ '400': *547
+ '401': *548
+ '403': *549
+ '409': &556
description: Duplicate record detected
- '429': *553
- '500': *554
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80056,7 +79608,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group
parameters:
- - &557
+ - &554
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
@@ -80064,22 +79616,22 @@ paths:
schema:
type: string
example: 7fce0092-d52e-4f76-b727-3955bd72c939
- - *555
+ - *552
- *65
responses:
'200':
description: Success, a group was found
content:
application/scim+json:
- schema: *549
+ schema: *546
examples:
- default: *556
- '400': *550
- '401': *551
- '403': *552
+ default: *553
+ '400': *547
+ '401': *548
+ '403': *549
'404': *26
- '429': *553
- '500': *554
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80101,13 +79653,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group
parameters:
- - *557
+ - *554
- *65
requestBody:
required: true
content:
application/json:
- schema: *558
+ schema: *555
examples:
group:
summary: Group
@@ -80133,17 +79685,17 @@ paths:
description: Group was updated
content:
application/scim+json:
- schema: *549
+ schema: *546
examples:
- group: *556
- groupWithMembers: *556
- '400': *550
- '401': *551
- '403': *552
+ group: *553
+ groupWithMembers: *553
+ '400': *547
+ '401': *548
+ '403': *549
'404': *26
- '409': *559
- '429': *553
- '500': *554
+ '409': *556
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80167,13 +79719,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
parameters:
- - *557
+ - *554
- *65
requestBody:
required: true
content:
application/json:
- schema: &569
+ schema: &566
type: object
required:
- Operations
@@ -80233,17 +79785,17 @@ paths:
description: Success, group was updated
content:
application/scim+json:
- schema: *549
+ schema: *546
examples:
- updateGroup: *556
- addMembers: *556
- '400': *550
- '401': *551
- '403': *552
+ updateGroup: *553
+ addMembers: *553
+ '400': *547
+ '401': *548
+ '403': *549
'404': *26
- '409': *559
- '429': *553
- '500': *554
+ '409': *556
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80263,17 +79815,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise
parameters:
- - *557
+ - *554
- *65
responses:
'204':
description: Group was deleted, no content
- '400': *550
- '401': *551
- '403': *552
+ '400': *547
+ '401': *548
+ '403': *549
'404': *26
- '429': *553
- '500': *554
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80310,8 +79862,8 @@ paths:
value: userName eq 'E012345'
externalId:
value: externalId eq 'E012345'
- - *560
- - *561
+ - *557
+ - *558
- *65
responses:
'200':
@@ -80344,7 +79896,7 @@ paths:
Resources:
type: array
description: Information about each provisioned account.
- items: &564
+ items: &561
allOf:
- type: object
required:
@@ -80423,7 +79975,7 @@ paths:
description: Whether this email address is the primary
address.
example: true
- roles: &563
+ roles: &560
type: array
description: The roles assigned to the user.
items:
@@ -80479,7 +80031,7 @@ paths:
type: string
description: Provisioned SCIM groups that the user is
a member of.
- meta: *562
+ meta: *559
startIndex:
type: integer
description: A starting index for the returned page
@@ -80516,11 +80068,11 @@ paths:
primary: false
startIndex: 1
itemsPerPage: 20
- '400': *550
- '401': *551
- '403': *552
- '429': *553
- '500': *554
+ '400': *547
+ '401': *548
+ '403': *549
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80549,7 +80101,7 @@ paths:
required: true
content:
application/json:
- schema: &567
+ schema: &564
type: object
required:
- schemas
@@ -80631,9 +80183,9 @@ paths:
type: boolean
description: Whether this email address is the primary address.
example: true
- roles: *563
+ roles: *560
examples:
- user: &568
+ user: &565
summary: User
value:
schemas:
@@ -80680,9 +80232,9 @@ paths:
description: User has been created
content:
application/scim+json:
- schema: *564
+ schema: *561
examples:
- user: &565
+ user: &562
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
@@ -80708,13 +80260,13 @@ paths:
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939
- enterpriseOwner: *565
- '400': *550
- '401': *551
- '403': *552
- '409': *559
- '429': *553
- '500': *554
+ enterpriseOwner: *562
+ '400': *547
+ '401': *548
+ '403': *549
+ '409': *556
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80735,7 +80287,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user
parameters:
- - &566
+ - &563
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
@@ -80748,15 +80300,15 @@ paths:
description: Success, a user was found
content:
application/scim+json:
- schema: *564
+ schema: *561
examples:
- default: *565
- '400': *550
- '401': *551
- '403': *552
+ default: *562
+ '400': *547
+ '401': *548
+ '403': *549
'404': *26
- '429': *553
- '500': *554
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80781,30 +80333,30 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user
parameters:
- - *566
+ - *563
- *65
requestBody:
required: true
content:
application/json:
- schema: *567
+ schema: *564
examples:
- user: *568
+ user: *565
responses:
'200':
description: User was updated
content:
application/scim+json:
- schema: *564
+ schema: *561
examples:
- user: *565
- '400': *550
- '401': *551
- '403': *552
+ user: *562
+ '400': *547
+ '401': *548
+ '403': *549
'404': *26
- '409': *559
- '429': *553
- '500': *554
+ '409': *556
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80842,13 +80394,13 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
parameters:
- - *566
+ - *563
- *65
requestBody:
required: true
content:
application/json:
- schema: *569
+ schema: *566
examples:
userMultiValuedProperties:
summary: Multi Valued Property
@@ -80888,18 +80440,18 @@ paths:
description: Success, user was updated
content:
application/scim+json:
- schema: *564
- examples:
- userMultiValuedProperties: *565
- userSingleValuedProperties: *565
- disableUser: *565
- '400': *550
- '401': *551
- '403': *552
+ schema: *561
+ examples:
+ userMultiValuedProperties: *562
+ userSingleValuedProperties: *562
+ disableUser: *562
+ '400': *547
+ '401': *548
+ '403': *549
'404': *26
- '409': *559
- '429': *553
- '500': *554
+ '409': *556
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -80919,17 +80471,17 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise
parameters:
- - *566
+ - *563
- *65
responses:
'204':
description: User was deleted, no content
- '400': *550
- '401': *551
- '403': *552
+ '400': *547
+ '401': *548
+ '403': *549
'404': *26
- '429': *553
- '500': *554
+ '429': *550
+ '500': *551
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
@@ -81056,7 +80608,7 @@ paths:
example:
- 73..77
- 77..78
- text_matches: &570
+ text_matches: &567
title: Search Result Text Matches
type: array
items:
@@ -81219,7 +80771,7 @@ paths:
enum:
- author-date
- committer-date
- - &571
+ - &568
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
@@ -81290,7 +80842,7 @@ paths:
description: Metaproperties for Git author/committer
information.
type: object
- properties: *355
+ properties: *352
nullable: true
comment_count:
type: integer
@@ -81310,7 +80862,7 @@ paths:
url:
type: string
format: uri
- verification: *450
+ verification: *447
required:
- author
- committer
@@ -81329,7 +80881,7 @@ paths:
title: Git User
description: Metaproperties for Git author/committer information.
type: object
- properties: *355
+ properties: *352
nullable: true
parents:
type: array
@@ -81347,7 +80899,7 @@ paths:
type: number
node_id:
type: string
- text_matches: *570
+ text_matches: *567
required:
- sha
- node_id
@@ -81540,7 +81092,7 @@ paths:
- interactions
- created
- updated
- - *571
+ - *568
- *4
- *5
- name: advanced_search
@@ -81637,11 +81189,11 @@ paths:
description:
type: string
nullable: true
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
type: string
state_reason:
@@ -81673,7 +81225,7 @@ paths:
type: string
format: date-time
nullable: true
- text_matches: *570
+ text_matches: *567
pull_request:
type: object
properties:
@@ -81717,7 +81269,7 @@ paths:
timeline_url:
type: string
format: uri
- type: *575
+ type: *572
performed_via_github_app:
title: GitHub app
description: GitHub apps are a new way to extend GitHub.
@@ -81898,7 +81450,7 @@ paths:
enum:
- created
- updated
- - *571
+ - *568
- *4
- *5
responses:
@@ -81942,7 +81494,7 @@ paths:
nullable: true
score:
type: number
- text_matches: *570
+ text_matches: *567
required:
- id
- node_id
@@ -82028,7 +81580,7 @@ paths:
- forks
- help-wanted-issues
- updated
- - *571
+ - *568
- *4
- *5
responses:
@@ -82267,7 +81819,7 @@ paths:
- admin
- pull
- push
- text_matches: *570
+ text_matches: *567
temp_clone_token:
type: string
allow_merge_commit:
@@ -82568,7 +82120,7 @@ paths:
type: string
format: uri
nullable: true
- text_matches: *570
+ text_matches: *567
related:
type: array
nullable: true
@@ -82761,7 +82313,7 @@ paths:
- followers
- repositories
- joined
- - *571
+ - *568
- *4
- *5
responses:
@@ -82865,7 +82417,7 @@ paths:
hireable:
type: boolean
nullable: true
- text_matches: *570
+ text_matches: *567
blog:
type: string
nullable: true
@@ -83060,7 +82612,7 @@ paths:
description: Response
content:
application/json:
- schema: &576
+ schema: &573
type: object
properties:
status:
@@ -83080,7 +82632,7 @@ paths:
- name
- number
examples:
- default: &577
+ default: &574
value:
status: scheduled
scheduled_time: Tuesday, January 22 at 15:34 -0800
@@ -83125,9 +82677,9 @@ paths:
description: Response
content:
application/json:
- schema: *576
+ schema: *573
examples:
- default: *577
+ default: *574
'401':
description: Unauthorized
requestBody:
@@ -83691,7 +83243,7 @@ paths:
application/json:
schema:
type: array
- items: &578
+ items: &575
type: object
properties:
key:
@@ -83699,7 +83251,7 @@ paths:
pretty-print:
type: string
examples:
- default: &579
+ default: &576
value:
- key: ssh-rsa AAAAB3NzaC1yc2EAAAAB...
pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64
@@ -83742,9 +83294,9 @@ paths:
application/json:
schema:
type: array
- items: *578
+ items: *575
examples:
- default: *579
+ default: *576
'401':
description: Unauthorized
requestBody:
@@ -83796,9 +83348,9 @@ paths:
application/json:
schema:
type: array
- items: *578
+ items: *575
examples:
- default: *579
+ default: *576
'401':
description: Unauthorized
requestBody:
@@ -84098,226 +83650,6 @@ paths:
category: teams
subcategory: teams
deprecated: true
- "/teams/{team_id}/discussions":
- get:
- summary: List discussions (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 discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint.
-
- List all discussions on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/list-discussions-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy
- parameters:
- - *7
- - *9
- - *4
- - *5
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema:
- type: array
- items: *289
- examples:
- default: *580
- headers:
- Link: *6
- 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]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint.
-
- Creates a new discussion post on a team's page.
-
- This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)."
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/create-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion-legacy
- parameters:
- - *7
- 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: *289
- examples:
- default: *290
- x-github:
- triggersNotification: true
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- "/teams/{team_id}/discussions/{discussion_number}":
- get:
- summary: Get a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint.
-
- Get a specific discussion on a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/get-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy
- parameters:
- - *7
- - *291
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *289
- examples:
- default: *290
- 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]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint.
-
- Edits the title and body text of a discussion post. Only the parameters you provide are updated.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/update-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy
- parameters:
- - *7
- - *291
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- title:
- type: string
- description: The discussion post's title.
- body:
- type: string
- description: The discussion post's body text.
- examples:
- default:
- value:
- title: Welcome to our first team post
- responses:
- '200':
- description: Response
- content:
- application/json:
- schema: *289
- examples:
- default: *581
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
- delete:
- summary: Delete a discussion (Legacy)
- description: |-
- > [!WARNING]
- > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint.
-
- Delete a discussion from a team's page.
-
- OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
- tags:
- - teams
- operationId: teams/delete-discussion-legacy
- externalDocs:
- description: API method documentation
- url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion-legacy
- parameters:
- - *7
- - *291
- responses:
- '204':
- description: Response
- x-github:
- githubCloudOnly: false
- enabledForGitHubApps: true
- removalDate: '2021-02-01'
- deprecationDate: '2020-01-21'
- category: teams
- subcategory: discussions
- deprecated: true
"/teams/{team_id}/members":
get:
summary: List team members (Legacy)
@@ -84505,9 +83837,9 @@ paths:
description: Response
content:
application/json:
- schema: *296
+ schema: *293
examples:
- response-if-user-is-a-team-maintainer: *582
+ response-if-user-is-a-team-maintainer: *577
'404': *26
x-github:
githubCloudOnly: false
@@ -84566,9 +83898,9 @@ paths:
description: Response
content:
application/json:
- schema: *296
+ schema: *293
examples:
- response-if-users-membership-with-team-is-now-pending: *583
+ response-if-users-membership-with-team-is-now-pending: *578
'403':
description: Forbidden if team synchronization is set up
'422':
@@ -84641,9 +83973,9 @@ paths:
application/json:
schema:
type: array
- items: *297
+ items: *294
examples:
- default: *584
+ default: *579
headers:
Link: *6
'404': *26
@@ -84670,15 +84002,15 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project-legacy
parameters:
- *7
- - *298
+ - *295
responses:
'200':
description: Response
content:
application/json:
- schema: *297
+ schema: *294
examples:
- default: *585
+ default: *580
'404':
description: Not Found if project is not managed by this team
x-github:
@@ -84703,7 +84035,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions-legacy
parameters:
- *7
- - *298
+ - *295
requestBody:
required: false
content:
@@ -84772,7 +84104,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team-legacy
parameters:
- *7
- - *298
+ - *295
responses:
'204':
description: Response
@@ -84842,14 +84174,14 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository-legacy
parameters:
- *7
- - *299
- - *300
+ - *296
+ - *297
responses:
'200':
description: Alternative response with extra repository information
content:
application/json:
- schema: *586
+ schema: *581
examples:
alternative-response-with-extra-repository-information:
value:
@@ -85001,8 +84333,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- *7
- - *299
- - *300
+ - *296
+ - *297
requestBody:
required: false
content:
@@ -85053,8 +84385,8 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team-legacy
parameters:
- *7
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -85089,9 +84421,9 @@ paths:
application/json:
schema:
type: array
- items: *301
+ items: *298
examples:
- response-if-child-teams-exist: *587
+ response-if-child-teams-exist: *582
headers:
Link: *6
'404': *26
@@ -85124,7 +84456,7 @@ paths:
application/json:
schema:
oneOf:
- - &589
+ - &584
title: Private User
description: Private User
type: object
@@ -85327,7 +84659,7 @@ paths:
- private_gists
- total_private_repos
- two_factor_authentication
- - *588
+ - *583
examples:
response-with-public-and-private-profile-information:
summary: Response with public and private profile information
@@ -85478,7 +84810,7 @@ paths:
description: Response
content:
application/json:
- schema: *589
+ schema: *584
examples:
default:
value:
@@ -85556,7 +84888,7 @@ paths:
type: array
items: *224
examples:
- default: &599
+ default: &594
value:
- id: 197
name: hello_docker
@@ -85643,7 +84975,7 @@ paths:
application/json:
schema:
type: array
- items: &590
+ items: &585
title: Email
description: Email
type: object
@@ -85668,7 +85000,7 @@ paths:
- verified
- visibility
examples:
- default: &601
+ default: &596
value:
- email: octocat@github.com
verified: true
@@ -85743,7 +85075,7 @@ paths:
application/json:
schema:
type: array
- items: *590
+ items: *585
examples:
default:
value:
@@ -85999,7 +85331,7 @@ paths:
application/json:
schema:
type: array
- items: &591
+ items: &586
title: GPG Key
description: A unique encryption key
type: object
@@ -86130,7 +85462,7 @@ paths:
- subkeys
- revoked
examples:
- default: &611
+ default: &606
value:
- id: 3
name: Octocat's GPG Key
@@ -86215,9 +85547,9 @@ paths:
description: Response
content:
application/json:
- schema: *591
+ schema: *586
examples:
- default: &592
+ default: &587
value:
id: 3
name: Octocat's GPG Key
@@ -86274,7 +85606,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
parameters:
- - &593
+ - &588
name: gpg_key_id
description: The unique identifier of the GPG key.
in: path
@@ -86286,9 +85618,9 @@ paths:
description: Response
content:
application/json:
- schema: *591
+ schema: *586
examples:
- default: *592
+ default: *587
'404': *26
'304': *42
'403': *43
@@ -86311,7 +85643,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
parameters:
- - *593
+ - *588
responses:
'204':
description: Response
@@ -86502,7 +85834,7 @@ paths:
type: array
items: *84
examples:
- default: *594
+ default: *589
headers:
Link: *6
'404': *26
@@ -86678,7 +86010,7 @@ paths:
application/json:
schema:
type: array
- items: &595
+ items: &590
title: Key
description: Key
type: object
@@ -86779,9 +86111,9 @@ paths:
description: Response
content:
application/json:
- schema: *595
+ schema: *590
examples:
- default: &596
+ default: &591
value:
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
id: 2
@@ -86814,15 +86146,15 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *485
+ - *482
responses:
'200':
description: Response
content:
application/json:
- schema: *595
+ schema: *590
examples:
- default: *596
+ default: *591
'404': *26
'304': *42
'403': *43
@@ -86845,7 +86177,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
parameters:
- - *485
+ - *482
responses:
'204':
description: Response
@@ -87665,7 +86997,7 @@ paths:
type: array
items: *70
examples:
- default: *597
+ default: *592
headers:
Link: *6
'304': *42
@@ -87707,7 +87039,7 @@ paths:
- docker
- nuget
- container
- - *598
+ - *593
- *5
- *4
responses:
@@ -87719,8 +87051,8 @@ paths:
type: array
items: *224
examples:
- default: *599
- '400': *600
+ default: *594
+ '400': *595
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -87749,7 +87081,7 @@ paths:
application/json:
schema: *224
examples:
- default: &612
+ default: &607
value:
id: 40201
name: octo-name
@@ -88200,9 +87532,9 @@ paths:
application/json:
schema:
type: array
- items: *590
+ items: *585
examples:
- default: *601
+ default: *596
headers:
Link: *6
'304': *42
@@ -88315,7 +87647,7 @@ paths:
type: array
items: *84
examples:
- default: &608
+ default: &603
summary: Default response
value:
- id: 1296269
@@ -88619,9 +87951,9 @@ paths:
description: Response
content:
application/json:
- schema: *310
+ schema: *307
examples:
- default: *312
+ default: *309
headers:
Location:
example: https://api.github.com/repos/octocat/Hello-World
@@ -88659,9 +87991,9 @@ paths:
application/json:
schema:
type: array
- items: *457
+ items: *454
examples:
- default: *602
+ default: *597
headers:
Link: *6
'304': *42
@@ -88684,7 +88016,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#accept-a-repository-invitation
parameters:
- - *458
+ - *455
responses:
'204':
description: Response
@@ -88707,7 +88039,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#decline-a-repository-invitation
parameters:
- - *458
+ - *455
responses:
'204':
description: Response
@@ -88740,7 +88072,7 @@ paths:
application/json:
schema:
type: array
- items: &603
+ items: &598
title: Social account
description: Social media account
type: object
@@ -88755,7 +88087,7 @@ paths:
- provider
- url
examples:
- default: &604
+ default: &599
value:
- provider: twitter
url: https://twitter.com/github
@@ -88817,9 +88149,9 @@ paths:
application/json:
schema:
type: array
- items: *603
+ items: *598
examples:
- default: *604
+ default: *599
'422': *35
'304': *42
'404': *26
@@ -88906,7 +88238,7 @@ paths:
application/json:
schema:
type: array
- items: &605
+ items: &600
title: SSH Signing Key
description: A public SSH key used to sign Git commits
type: object
@@ -88926,7 +88258,7 @@ paths:
- title
- created_at
examples:
- default: &613
+ default: &608
value:
- id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -88990,9 +88322,9 @@ paths:
description: Response
content:
application/json:
- schema: *605
+ schema: *600
examples:
- default: &606
+ default: &601
value:
id: 2
key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
@@ -89022,7 +88354,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - &607
+ - &602
name: ssh_signing_key_id
description: The unique identifier of the SSH signing key.
in: path
@@ -89034,9 +88366,9 @@ paths:
description: Response
content:
application/json:
- schema: *605
+ schema: *600
examples:
- default: *606
+ default: *601
'404': *26
'304': *42
'403': *43
@@ -89059,7 +88391,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
parameters:
- - *607
+ - *602
responses:
'204':
description: Response
@@ -89088,7 +88420,7 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
parameters:
- - &614
+ - &609
name: sort
description: The property to sort the results by. `created` means when the
repository was starred. `updated` means when the repository was last pushed
@@ -89113,11 +88445,11 @@ paths:
type: array
items: *84
examples:
- default-response: *608
+ default-response: *603
application/vnd.github.v3.star+json:
schema:
type: array
- items: &615
+ items: &610
title: Starred Repository
description: Starred Repository
type: object
@@ -89273,8 +88605,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response if this repository is starred by you
@@ -89302,8 +88634,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#star-a-repository-for-the-authenticated-user
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -89327,8 +88659,8 @@ paths:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#unstar-a-repository-for-the-authenticated-user
parameters:
- - *299
- - *300
+ - *296
+ - *297
responses:
'204':
description: Response
@@ -89487,10 +88819,10 @@ paths:
application/json:
schema:
oneOf:
- - *589
- - *588
+ - *584
+ - *583
examples:
- default-response: &609
+ default-response: &604
summary: Default response
value:
login: octocat
@@ -89525,7 +88857,7 @@ paths:
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
- response-with-git-hub-plan-information: &610
+ response-with-git-hub-plan-information: &605
summary: Response with GitHub plan information
value:
login: octocat
@@ -89637,11 +88969,11 @@ paths:
application/json:
schema:
oneOf:
- - *589
- - *588
+ - *584
+ - *583
examples:
- default-response: *609
- response-with-git-hub-plan-information: *610
+ default-response: *604
+ response-with-git-hub-plan-information: *605
'404': *26
x-github:
githubCloudOnly: false
@@ -89672,7 +89004,7 @@ paths:
type: array
items: *224
examples:
- default: *599
+ default: *594
'403': *43
'401': *41
x-github:
@@ -90085,9 +89417,9 @@ paths:
application/json:
schema:
type: array
- items: *591
+ items: *586
examples:
- default: *611
+ default: *606
headers:
Link: *6
x-github:
@@ -90191,7 +89523,7 @@ paths:
application/json:
schema: *39
examples:
- default: *456
+ default: *453
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -90276,7 +89608,7 @@ paths:
type: array
items: *70
examples:
- default: *597
+ default: *592
headers:
Link: *6
x-github:
@@ -90315,7 +89647,7 @@ paths:
- docker
- nuget
- container
- - *598
+ - *593
- *8
- *5
- *4
@@ -90328,10 +89660,10 @@ paths:
type: array
items: *224
examples:
- default: *599
+ default: *594
'403': *43
'401': *41
- '400': *600
+ '400': *595
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -90361,7 +89693,7 @@ paths:
application/json:
schema: *224
examples:
- default: *612
+ default: *607
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
@@ -90990,9 +90322,9 @@ paths:
application/json:
schema:
type: array
- items: *603
+ items: *598
examples:
- default: *604
+ default: *599
headers:
Link: *6
x-github:
@@ -91022,9 +90354,9 @@ paths:
application/json:
schema:
type: array
- items: *605
+ items: *600
examples:
- default: *613
+ default: *608
headers:
Link: *6
x-github:
@@ -91049,7 +90381,7 @@ paths:
url: https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-a-user
parameters:
- *8
- - *614
+ - *609
- *9
- *4
- *5
@@ -91061,11 +90393,11 @@ paths:
schema:
anyOf:
- type: array
- items: *615
+ items: *610
- type: array
items: *84
examples:
- default-response: *608
+ default-response: *603
headers:
Link: *6
x-github:
@@ -91275,7 +90607,7 @@ x-webhooks:
type: string
enum:
- disabled
- enterprise: &616
+ enterprise: &611
title: Enterprise
description: |-
An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured
@@ -91333,7 +90665,7 @@ x-webhooks:
- created_at
- updated_at
- avatar_url
- installation: &617
+ installation: &612
title: Simple Installation
description: |-
The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
@@ -91352,7 +90684,7 @@ x-webhooks:
required:
- id
- node_id
- organization: &618
+ organization: &613
title: Organization Simple
description: |-
A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
@@ -91412,13 +90744,13 @@ x-webhooks:
- public_members_url
- avatar_url
- description
- repository: &619
+ repository: &614
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: &647
+ properties: &642
id:
description: Unique identifier of the repository
example: 42
@@ -92101,7 +91433,7 @@ x-webhooks:
type: boolean
description: Whether anonymous git access is enabled for this
repository
- required: &648
+ required: &643
- archive_url
- assignees_url
- blobs_url
@@ -92252,10 +91584,10 @@ x-webhooks:
type: string
enum:
- enabled
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -92341,11 +91673,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- rule: &620
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ rule: &615
title: branch protection rule
description: The branch protection rule. Includes a `name` and all
the [branch protection settings](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings)
@@ -92562,11 +91894,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- rule: *620
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ rule: *615
sender: *19
required:
- action
@@ -92740,11 +92072,11 @@ x-webhooks:
- everyone
required:
- from
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- rule: *620
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ rule: *615
sender: *19
required:
- action
@@ -92825,11 +92157,11 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- exemption_request: &621
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ exemption_request: &616
title: Exemption Request
description: A request from a user to be exempted from a set of
rules.
@@ -93098,7 +92430,7 @@ x-webhooks:
type: array
description: The responses to the exemption request.
nullable: true
- items: &622
+ items: &617
title: Exemption response
description: A response to an exemption request by a delegated
bypasser.
@@ -93216,11 +92548,11 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- exemption_request: *621
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ exemption_request: *616
sender: *19
required:
- action
@@ -93300,11 +92632,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- exemption_request: *621
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ exemption_request: *616
sender: *19
required:
- action
@@ -93384,12 +92716,12 @@ x-webhooks:
type: string
enum:
- response_dismissed
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- exemption_request: *621
- exemption_response: *622
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ exemption_request: *616
+ exemption_response: *617
sender: *19
required:
- action
@@ -93471,12 +92803,12 @@ x-webhooks:
type: string
enum:
- response_submitted
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- exemption_request: *621
- exemption_response: *622
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ exemption_request: *616
+ exemption_response: *617
sender: *19
required:
- action
@@ -93561,12 +92893,12 @@ x-webhooks:
type: string
cache_location:
type: string
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
ref:
type: string
- repository: *619
+ repository: *614
sender: *19
required:
- cache_location
@@ -93660,7 +92992,7 @@ x-webhooks:
type: string
enum:
- completed
- check_run: &624
+ check_run: &619
title: CheckRun
description: A check performed on the code of a given code change
type: object
@@ -93713,7 +93045,7 @@ x-webhooks:
type: string
pull_requests:
type: array
- items: *368
+ items: *365
repository: *158
status:
example: completed
@@ -93751,7 +93083,7 @@ x-webhooks:
- skipped
- timed_out
- action_required
- deployment: *623
+ deployment: *618
details_url:
example: https://example.com
type: string
@@ -93801,7 +93133,7 @@ x-webhooks:
- annotations_url
pull_requests:
type: array
- items: *368
+ items: *365
started_at:
example: '2018-05-04T01:14:52Z'
type: string
@@ -93836,10 +93168,10 @@ x-webhooks:
- output
- app
- pull_requests
- installation: *617
- enterprise: *616
- organization: *618
- repository: *619
+ installation: *612
+ enterprise: *611
+ organization: *613
+ repository: *614
sender: *19
required:
- check_run
@@ -94242,11 +93574,11 @@ x-webhooks:
type: string
enum:
- created
- check_run: *624
- installation: *617
- enterprise: *616
- organization: *618
- repository: *619
+ check_run: *619
+ installation: *612
+ enterprise: *611
+ organization: *613
+ repository: *614
sender: *19
required:
- check_run
@@ -94652,11 +93984,11 @@ x-webhooks:
type: string
enum:
- requested_action
- check_run: *624
- installation: *617
- enterprise: *616
- organization: *618
- repository: *619
+ check_run: *619
+ installation: *612
+ enterprise: *611
+ organization: *613
+ repository: *614
requested_action:
description: The action requested by the user.
type: object
@@ -95071,11 +94403,11 @@ x-webhooks:
type: string
enum:
- rerequested
- check_run: *624
- installation: *617
- enterprise: *616
- organization: *618
- repository: *619
+ check_run: *619
+ installation: *612
+ enterprise: *611
+ organization: *613
+ repository: *614
sender: *19
required:
- check_run
@@ -96062,10 +95394,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -96769,10 +96101,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -97470,10 +96802,10 @@ x-webhooks:
- latest_check_runs_count
- check_runs_url
- head_commit
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -97649,7 +96981,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *381
+ dismissed_comment: *378
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -97794,20 +97126,20 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: &625
+ commit_oid: &620
description: The commit SHA of the code scanning alert. When the
action is `reopened_by_user` or `closed_by_user`, the event was
triggered by the `sender` and this value will be empty.
type: string
- enterprise: *616
- installation: *617
- organization: *618
- ref: &626
+ enterprise: *611
+ installation: *612
+ organization: *613
+ ref: &621
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -97982,7 +97314,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *381
+ dismissed_comment: *378
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -98212,12 +97544,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *625
- enterprise: *616
- installation: *617
- organization: *618
- ref: *626
- repository: *619
+ commit_oid: *620
+ enterprise: *611
+ installation: *612
+ organization: *613
+ ref: *621
+ repository: *614
sender: *19
required:
- action
@@ -98322,7 +97654,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *381
+ dismissed_comment: *378
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -98493,12 +97825,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *625
- enterprise: *616
- installation: *617
- organization: *618
- ref: *626
- repository: *619
+ commit_oid: *620
+ enterprise: *611
+ installation: *612
+ organization: *613
+ ref: *621
+ repository: *614
sender: *19
required:
- action
@@ -98674,7 +98006,7 @@ x-webhooks:
required:
- login
- id
- dismissed_comment: *381
+ dismissed_comment: *378
dismissed_reason:
description: The reason for dismissing or closing the alert.
type: string
@@ -98840,12 +98172,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *625
- enterprise: *616
- installation: *617
- organization: *618
- ref: *626
- repository: *619
+ commit_oid: *620
+ enterprise: *611
+ installation: *612
+ organization: *613
+ ref: *621
+ repository: *614
sender: *19
required:
- action
@@ -98954,7 +98286,7 @@ x-webhooks:
dismissed_by:
type: object
nullable: true
- dismissed_comment: *381
+ dismissed_comment: *378
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -99129,16 +98461,16 @@ x-webhooks:
triggered by the `sender` and this value will be empty.
type: string
nullable: true
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
ref:
description: The Git reference of the code scanning alert. When
the action is `reopened_by_user` or `closed_by_user`, the event
was triggered by the `sender` and this value will be empty.
type: string
nullable: true
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -99245,7 +98577,7 @@ x-webhooks:
nullable: true
dismissed_by:
nullable: true
- dismissed_comment: *381
+ dismissed_comment: *378
dismissed_reason:
description: 'The reason for dismissing or closing the alert.
Can be one of: `false positive`, `won''t fix`, and `used in
@@ -99385,12 +98717,12 @@ x-webhooks:
- dismissed_reason
- rule
- tool
- commit_oid: *625
- enterprise: *616
- installation: *617
- organization: *618
- ref: *626
- repository: *619
+ commit_oid: *620
+ enterprise: *611
+ installation: *612
+ organization: *613
+ ref: *621
+ repository: *614
sender: *19
required:
- action
@@ -99657,10 +98989,10 @@ x-webhooks:
- updated_at
- author_association
- body
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -99750,18 +99082,18 @@ x-webhooks:
description: The repository's current description.
type: string
nullable: true
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
master_branch:
description: The name of the repository's default branch (usually
`main`).
type: string
- organization: *618
- pusher_type: &627
+ organization: *613
+ pusher_type: &622
description: The pusher type for the event. Can be either `user`
or a deploy key.
type: string
- ref: &628
+ ref: &623
description: The [`git ref`](https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference)
resource.
type: string
@@ -99771,7 +99103,7 @@ x-webhooks:
enum:
- tag
- branch
- repository: *619
+ repository: *614
sender: *19
required:
- ref
@@ -99854,9 +99186,9 @@ x-webhooks:
enum:
- created
definition: *244
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
sender: *19
required:
- action
@@ -99941,9 +99273,9 @@ x-webhooks:
description: The name of the property that was deleted.
required:
- property_name
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
sender: *19
required:
- action
@@ -100021,9 +99353,9 @@ x-webhooks:
enum:
- updated
definition: *244
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
sender: *19
required:
- action
@@ -100100,10 +99432,10 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *616
- installation: *617
- repository: *619
- organization: *618
+ enterprise: *611
+ installation: *612
+ repository: *614
+ organization: *613
sender: *19
new_property_values:
type: array
@@ -100198,18 +99530,18 @@ x-webhooks:
title: delete event
type: object
properties:
- enterprise: *616
- installation: *617
- organization: *618
- pusher_type: *627
- ref: *628
+ enterprise: *611
+ installation: *612
+ organization: *613
+ pusher_type: *622
+ ref: *623
ref_type:
description: The type of Git ref object deleted in the repository.
type: string
enum:
- tag
- branch
- repository: *619
+ repository: *614
sender: *19
required:
- ref
@@ -100303,11 +99635,11 @@ x-webhooks:
type: string
enum:
- auto_dismissed
- alert: *419
- installation: *617
- organization: *618
- enterprise: *616
- repository: *619
+ alert: *416
+ installation: *612
+ organization: *613
+ enterprise: *611
+ repository: *614
sender: *19
required:
- action
@@ -100401,11 +99733,11 @@ x-webhooks:
type: string
enum:
- auto_reopened
- alert: *419
- installation: *617
- organization: *618
- enterprise: *616
- repository: *619
+ alert: *416
+ installation: *612
+ organization: *613
+ enterprise: *611
+ repository: *614
sender: *19
required:
- action
@@ -100499,11 +99831,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *419
- installation: *617
- organization: *618
- enterprise: *616
- repository: *619
+ alert: *416
+ installation: *612
+ organization: *613
+ enterprise: *611
+ repository: *614
sender: *19
required:
- action
@@ -100595,11 +99927,11 @@ x-webhooks:
type: string
enum:
- dismissed
- alert: *419
- installation: *617
- organization: *618
- enterprise: *616
- repository: *619
+ alert: *416
+ installation: *612
+ organization: *613
+ enterprise: *611
+ repository: *614
sender: *19
required:
- action
@@ -100691,11 +100023,11 @@ x-webhooks:
type: string
enum:
- fixed
- alert: *419
- installation: *617
- organization: *618
- enterprise: *616
- repository: *619
+ alert: *416
+ installation: *612
+ organization: *613
+ enterprise: *611
+ repository: *614
sender: *19
required:
- action
@@ -100788,11 +100120,11 @@ x-webhooks:
type: string
enum:
- reintroduced
- alert: *419
- installation: *617
- organization: *618
- enterprise: *616
- repository: *619
+ alert: *416
+ installation: *612
+ organization: *613
+ enterprise: *611
+ repository: *614
sender: *19
required:
- action
@@ -100884,11 +100216,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *419
- installation: *617
- organization: *618
- enterprise: *616
- repository: *619
+ alert: *416
+ installation: *612
+ organization: *613
+ enterprise: *611
+ repository: *614
sender: *19
required:
- action
@@ -100975,9 +100307,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- key: &629
+ enterprise: *611
+ installation: *612
+ key: &624
description: The [`deploy key`](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key)
resource.
type: object
@@ -101011,8 +100343,8 @@ x-webhooks:
- verified
- created_at
- read_only
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -101099,11 +100431,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- key: *629
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ key: *624
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -101674,12 +101006,12 @@ x-webhooks:
- updated_at
- statuses_url
- repository_url
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- workflow: &633
+ workflow: &628
title: Workflow
type: object
nullable: true
@@ -102415,13 +101747,13 @@ x-webhooks:
description: The URL to review the deployment protection rule.
type: string
format: uri
- deployment: *425
+ deployment: *422
pull_requests:
type: array
items: *117
- repository: *619
- organization: *618
- installation: *617
+ repository: *614
+ organization: *613
+ installation: *612
sender: *19
responses:
'200':
@@ -102502,7 +101834,7 @@ x-webhooks:
type: string
enum:
- approved
- approver: &630
+ approver: &625
type: object
properties:
avatar_url:
@@ -102545,11 +101877,11 @@ x-webhooks:
type: string
comment:
type: string
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- reviewers: &631
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ reviewers: &626
type: array
items:
type: object
@@ -102628,7 +101960,7 @@ x-webhooks:
sender: *19
since:
type: string
- workflow_job_run: &632
+ workflow_job_run: &627
type: object
properties:
conclusion:
@@ -103369,18 +102701,18 @@ x-webhooks:
type: string
enum:
- rejected
- approver: *630
+ approver: *625
comment:
type: string
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- reviewers: *631
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ reviewers: *626
sender: *19
since:
type: string
- workflow_job_run: *632
+ workflow_job_run: *627
workflow_job_runs:
type: array
items:
@@ -104094,13 +103426,13 @@ x-webhooks:
type: string
enum:
- requested
- enterprise: *616
+ enterprise: *611
environment:
type: string
- installation: *617
- organization: *618
- repository: *619
- requestor: &638
+ installation: *612
+ organization: *613
+ repository: *614
+ requestor: &633
title: User
type: object
nullable: true
@@ -106009,12 +105341,12 @@ x-webhooks:
- updated_at
- deployment_url
- repository_url
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- workflow: *633
+ workflow: *628
workflow_run:
title: Deployment Workflow Run
type: object
@@ -106704,7 +106036,7 @@ x-webhooks:
type: string
enum:
- answered
- answer: &636
+ answer: &631
type: object
properties:
author_association:
@@ -106861,7 +106193,7 @@ x-webhooks:
- created_at
- updated_at
- body
- discussion: &634
+ discussion: &629
title: Discussion
description: A Discussion in a repository.
type: object
@@ -107168,10 +106500,10 @@ x-webhooks:
- updated_at
- active_lock_reason
- body
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -107308,11 +106640,11 @@ x-webhooks:
- from
required:
- category
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -107405,11 +106737,11 @@ x-webhooks:
type: string
enum:
- closed
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -107501,7 +106833,7 @@ x-webhooks:
type: string
enum:
- created
- comment: &635
+ comment: &630
type: object
properties:
author_association:
@@ -107658,11 +106990,11 @@ x-webhooks:
- updated_at
- body
- reactions
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -107755,12 +107087,12 @@ x-webhooks:
type: string
enum:
- deleted
- comment: *635
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ comment: *630
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -107865,12 +107197,12 @@ x-webhooks:
- from
required:
- body
- comment: *635
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ comment: *630
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -107964,11 +107296,11 @@ x-webhooks:
type: string
enum:
- created
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108060,11 +107392,11 @@ x-webhooks:
type: string
enum:
- deleted
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108174,11 +107506,11 @@ x-webhooks:
type: string
required:
- from
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108270,10 +107602,10 @@ x-webhooks:
type: string
enum:
- labeled
- discussion: *634
- enterprise: *616
- installation: *617
- label: &637
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ label: &632
title: Label
type: object
properties:
@@ -108305,8 +107637,8 @@ x-webhooks:
- color
- default
- description
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108399,11 +107731,11 @@ x-webhooks:
type: string
enum:
- locked
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108495,11 +107827,11 @@ x-webhooks:
type: string
enum:
- pinned
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108591,11 +107923,11 @@ x-webhooks:
type: string
enum:
- reopened
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108690,16 +108022,16 @@ x-webhooks:
changes:
type: object
properties:
- new_discussion: *634
- new_repository: *619
+ new_discussion: *629
+ new_repository: *614
required:
- new_discussion
- new_repository
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108792,10 +108124,10 @@ x-webhooks:
type: string
enum:
- unanswered
- discussion: *634
- old_answer: *636
- organization: *618
- repository: *619
+ discussion: *629
+ old_answer: *631
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108887,12 +108219,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- discussion: *634
- enterprise: *616
- installation: *617
- label: *637
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ label: *632
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -108985,11 +108317,11 @@ x-webhooks:
type: string
enum:
- unlocked
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -109081,11 +108413,11 @@ x-webhooks:
type: string
enum:
- unpinned
- discussion: *634
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ discussion: *629
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -109326,7 +108658,7 @@ x-webhooks:
description: A user forks a repository.
type: object
properties:
- enterprise: *616
+ enterprise: *611
forkee:
description: The created [`repository`](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository)
resource.
@@ -109986,9 +109318,9 @@ x-webhooks:
type: integer
watchers_count:
type: integer
- installation: *617
- organization: *618
- repository: *619
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- forkee
@@ -110154,9 +109486,9 @@ x-webhooks:
title: gollum event
type: object
properties:
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
pages:
description: The pages that were updated.
type: array
@@ -110193,7 +109525,7 @@ x-webhooks:
- action
- sha
- html_url
- repository: *619
+ repository: *614
sender: *19
required:
- pages
@@ -110279,10 +109611,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
+ enterprise: *611
installation: *39
- organization: *618
- repositories: &639
+ organization: *613
+ repositories: &634
description: An array of repository objects that the installation
can access.
type: array
@@ -110308,8 +109640,8 @@ x-webhooks:
- name
- full_name
- private
- repository: *619
- requester: *638
+ repository: *614
+ requester: *633
sender: *19
required:
- action
@@ -110394,11 +109726,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
+ enterprise: *611
installation: *39
- organization: *618
- repositories: *639
- repository: *619
+ organization: *613
+ repositories: *634
+ repository: *614
requester:
nullable: true
sender: *19
@@ -110484,11 +109816,11 @@ x-webhooks:
type: string
enum:
- new_permissions_accepted
- enterprise: *616
+ enterprise: *611
installation: *39
- organization: *618
- repositories: *639
- repository: *619
+ organization: *613
+ repositories: *634
+ repository: *614
requester:
nullable: true
sender: *19
@@ -110574,10 +109906,10 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *616
+ enterprise: *611
installation: *39
- organization: *618
- repositories_added: &640
+ organization: *613
+ repositories_added: &635
description: An array of repository objects, which were added to
the installation.
type: array
@@ -110623,15 +109955,15 @@ x-webhooks:
private:
description: Whether the repository is private or public.
type: boolean
- repository: *619
- repository_selection: &641
+ repository: *614
+ repository_selection: &636
description: Describe whether all repositories have been selected
or there's a selection involved
type: string
enum:
- all
- selected
- requester: *638
+ requester: *633
sender: *19
required:
- action
@@ -110720,10 +110052,10 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *616
+ enterprise: *611
installation: *39
- organization: *618
- repositories_added: *640
+ organization: *613
+ repositories_added: *635
repositories_removed:
description: An array of repository objects, which were removed
from the installation.
@@ -110750,9 +110082,9 @@ x-webhooks:
- name
- full_name
- private
- repository: *619
- repository_selection: *641
- requester: *638
+ repository: *614
+ repository_selection: *636
+ requester: *633
sender: *19
required:
- action
@@ -110841,11 +110173,11 @@ x-webhooks:
type: string
enum:
- suspend
- enterprise: *616
+ enterprise: *611
installation: *39
- organization: *618
- repositories: *639
- repository: *619
+ organization: *613
+ repositories: *634
+ repository: *614
requester:
nullable: true
sender: *19
@@ -111034,10 +110366,10 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
target_type:
type: string
@@ -111126,11 +110458,11 @@ x-webhooks:
type: string
enum:
- unsuspend
- enterprise: *616
+ enterprise: *611
installation: *39
- organization: *618
- repositories: *639
- repository: *619
+ organization: *613
+ repositories: *634
+ repository: *614
requester:
nullable: true
sender: *19
@@ -111392,8 +110724,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -112187,8 +111519,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -112204,7 +111536,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -112537,8 +111869,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -112628,7 +111960,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &642
+ comment: &637
title: issue comment
description: The [comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment)
itself.
@@ -112793,8 +112125,8 @@ x-webhooks:
- performed_via_github_app
- body
- reactions
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -113584,8 +112916,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -113601,7 +112933,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -113936,8 +113268,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -114027,7 +113359,7 @@ x-webhooks:
type: string
enum:
- edited
- changes: &665
+ changes: &660
description: The changes to the comment.
type: object
properties:
@@ -114039,9 +113371,9 @@ x-webhooks:
type: string
required:
- from
- comment: *642
- enterprise: *616
- installation: *617
+ comment: *637
+ enterprise: *611
+ installation: *612
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
the comment belongs to.
@@ -114834,8 +114166,8 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -114851,7 +114183,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -115184,8 +114516,8 @@ x-webhooks:
- state
- locked
- assignee
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -115277,10 +114609,10 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *638
- enterprise: *616
- installation: *617
- issue: &645
+ assignee: *633
+ enterprise: *611
+ installation: *612
+ issue: &640
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -116069,11 +115401,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -116089,7 +115421,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -116190,8 +115522,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -116281,8 +115613,8 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -117076,11 +116408,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -117096,7 +116428,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -117332,8 +116664,8 @@ x-webhooks:
required:
- state
- closed_at
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -117422,8 +116754,8 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -118208,11 +117540,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -118228,7 +117560,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -118328,8 +117660,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -118418,8 +117750,8 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -119226,11 +118558,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -119246,7 +118578,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -119325,7 +118657,7 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: &643
+ milestone: &638
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -119463,8 +118795,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -119573,8 +118905,8 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -120363,11 +119695,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -120380,7 +119712,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *575
+ type: *572
title:
description: Title of the issue
type: string
@@ -120484,9 +119816,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *637
- organization: *618
- repository: *619
+ label: *632
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -120576,8 +119908,8 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -121365,11 +120697,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -121382,7 +120714,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *575
+ type: *572
title:
description: Title of the issue
type: string
@@ -121486,9 +120818,9 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- label: *637
- organization: *618
- repository: *619
+ label: *632
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -121578,8 +120910,8 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -122391,11 +121723,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -122408,7 +121740,7 @@ x-webhooks:
timeline_url:
type: string
format: uri
- type: *575
+ type: *572
title:
description: Title of the issue
type: string
@@ -122489,8 +121821,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -122579,8 +121911,8 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -123386,11 +122718,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -123406,7 +122738,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -123484,9 +122816,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- milestone: *643
- organization: *618
- repository: *619
+ milestone: *638
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -124364,11 +123696,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -124461,7 +123793,7 @@ x-webhooks:
required:
- login
- id
- type: *575
+ type: *572
required:
- id
- number
@@ -124930,8 +124262,8 @@ x-webhooks:
required:
- old_issue
- old_repository
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -125720,11 +125052,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -125740,7 +125072,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -125840,8 +125172,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -125931,9 +125263,9 @@ x-webhooks:
type: string
enum:
- pinned
- enterprise: *616
- installation: *617
- issue: &644
+ enterprise: *611
+ installation: *612
+ issue: &639
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
itself.
@@ -126716,11 +126048,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -126736,7 +126068,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -126836,8 +126168,8 @@ x-webhooks:
- active_lock_reason
- body
- reactions
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -126926,8 +126258,8 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -127737,11 +127069,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -127835,9 +127167,9 @@ x-webhooks:
format: uri
user_view_type:
type: string
- type: *575
- organization: *618
- repository: *619
+ type: *572
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -128713,11 +128045,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -128733,7 +128065,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -129301,11 +128633,11 @@ x-webhooks:
required:
- new_issue
- new_repository
- enterprise: *616
- installation: *617
- issue: *644
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ issue: *639
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -129396,7 +128728,7 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: &668
+ assignee: &663
title: User
type: object
nullable: true
@@ -129466,11 +128798,11 @@ x-webhooks:
required:
- login
- id
- enterprise: *616
- installation: *617
- issue: *645
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ issue: *640
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -129559,12 +128891,12 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *616
- installation: *617
- issue: *645
- label: *637
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ issue: *640
+ label: *632
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -129654,8 +128986,8 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
issue:
title: Issue
description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue)
@@ -130465,11 +129797,11 @@ x-webhooks:
repository_url:
type: string
format: uri
- sub_issues_summary: *572
- issue_dependencies_summary: *573
+ sub_issues_summary: *569
+ issue_dependencies_summary: *570
issue_field_values:
type: array
- items: *574
+ items: *571
state:
description: State of the issue; either 'open' or 'closed'
type: string
@@ -130485,7 +129817,7 @@ x-webhooks:
title:
description: Title of the issue
type: string
- type: *575
+ type: *572
updated_at:
type: string
format: date-time
@@ -130563,8 +129895,8 @@ x-webhooks:
format: uri
user_view_type:
type: string
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -130654,11 +129986,11 @@ x-webhooks:
type: string
enum:
- unpinned
- enterprise: *616
- installation: *617
- issue: *644
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ issue: *639
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -130747,11 +130079,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- label: *637
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ label: *632
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -130839,11 +130171,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- label: *637
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ label: *632
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -130963,11 +130295,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
- label: *637
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ label: *632
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -131081,11 +130413,11 @@ x-webhooks:
type: string
required:
- to
- enterprise: *616
- installation: *617
- member: *638
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ member: *633
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -131195,11 +130527,11 @@ x-webhooks:
to:
type: string
nullable: true
- enterprise: *616
- installation: *617
- member: *638
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ member: *633
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -131288,11 +130620,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *616
- installation: *617
- member: *638
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ member: *633
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -131380,11 +130712,11 @@ x-webhooks:
type: string
enum:
- added
- enterprise: *616
- installation: *617
- member: *638
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ member: *633
+ organization: *613
+ repository: *614
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -131460,7 +130792,7 @@ x-webhooks:
required:
- login
- id
- team: &646
+ team: &641
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -131693,11 +131025,11 @@ x-webhooks:
type: string
enum:
- removed
- enterprise: *616
- installation: *617
- member: *638
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ member: *633
+ organization: *613
+ repository: *614
scope:
description: The scope of the membership. Currently, can only be
`team`.
@@ -131774,7 +131106,7 @@ x-webhooks:
required:
- login
- id
- team: *646
+ team: *641
required:
- action
- scope
@@ -131862,7 +131194,7 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
+ enterprise: *611
hook:
description: 'The deleted webhook. This will contain different keys
based on the type of webhook it is: repository, organization,
@@ -131971,16 +131303,16 @@ x-webhooks:
hook_id:
description: The id of the modified webhook.
type: integer
- installation: *617
- organization: *618
+ installation: *612
+ organization: *613
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *647
- required: *648
+ properties: *642
+ required: *643
nullable: true
sender: *19
required:
@@ -132071,11 +131403,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *616
- installation: *617
- milestone: *643
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ milestone: *638
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -132164,9 +131496,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- milestone: &649
+ enterprise: *611
+ installation: *612
+ milestone: &644
title: Milestone
description: A collection of related issues and pull requests.
type: object
@@ -132303,8 +131635,8 @@ x-webhooks:
- updated_at
- due_on
- closed_at
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -132393,11 +131725,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- milestone: *643
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ milestone: *638
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -132517,11 +131849,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
- milestone: *643
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ milestone: *638
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -132611,11 +131943,11 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *616
- installation: *617
- milestone: *649
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ milestone: *644
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -132704,9 +132036,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- membership: &650
+ enterprise: *611
+ installation: *612
+ membership: &645
title: Membership
description: The membership between the user and the organization.
Not present when the action is `member_invited`.
@@ -132813,8 +132145,8 @@ x-webhooks:
- role
- organization_url
- user
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -132902,11 +132234,11 @@ x-webhooks:
type: string
enum:
- member_added
- enterprise: *616
- installation: *617
- membership: *650
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ membership: *645
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -132995,8 +132327,8 @@ x-webhooks:
type: string
enum:
- member_invited
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
invitation:
description: The invitation for the user or email if the action
is `member_invited`.
@@ -133112,10 +132444,10 @@ x-webhooks:
- inviter
- team_count
- invitation_teams_url
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
- user: *638
+ user: *633
required:
- action
- invitation
@@ -133203,11 +132535,11 @@ x-webhooks:
type: string
enum:
- member_removed
- enterprise: *616
- installation: *617
- membership: *650
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ membership: *645
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -133304,11 +132636,11 @@ x-webhooks:
properties:
from:
type: string
- enterprise: *616
- installation: *617
- membership: *650
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ membership: *645
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -133394,9 +132726,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
package:
description: Information about the package.
type: object
@@ -133895,7 +133227,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: &651
+ items: &646
title: Ruby Gems metadata
type: object
properties:
@@ -133990,7 +133322,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -134076,9 +133408,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
package:
description: Information about the package.
type: object
@@ -134431,7 +133763,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *651
+ items: *646
source_url:
type: string
format: uri
@@ -134501,7 +133833,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -134688,12 +134020,12 @@ x-webhooks:
- duration
- created_at
- updated_at
- enterprise: *616
+ enterprise: *611
id:
type: integer
- installation: *617
- organization: *618
- repository: *619
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- id
@@ -134770,7 +134102,7 @@ x-webhooks:
type: string
enum:
- approved
- personal_access_token_request: &652
+ personal_access_token_request: &647
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
type: object
@@ -134916,10 +134248,10 @@ x-webhooks:
- token_expired
- token_expires_at
- token_last_used_at
- enterprise: *616
- organization: *618
+ enterprise: *611
+ organization: *613
sender: *19
- installation: *617
+ installation: *612
required:
- action
- personal_access_token_request
@@ -134996,11 +134328,11 @@ x-webhooks:
type: string
enum:
- cancelled
- personal_access_token_request: *652
- enterprise: *616
- organization: *618
+ personal_access_token_request: *647
+ enterprise: *611
+ organization: *613
sender: *19
- installation: *617
+ installation: *612
required:
- action
- personal_access_token_request
@@ -135076,11 +134408,11 @@ x-webhooks:
type: string
enum:
- created
- personal_access_token_request: *652
- enterprise: *616
- organization: *618
+ personal_access_token_request: *647
+ enterprise: *611
+ organization: *613
sender: *19
- installation: *617
+ installation: *612
required:
- action
- personal_access_token_request
@@ -135155,11 +134487,11 @@ x-webhooks:
type: string
enum:
- denied
- personal_access_token_request: *652
- organization: *618
- enterprise: *616
+ personal_access_token_request: *647
+ organization: *613
+ enterprise: *611
sender: *19
- installation: *617
+ installation: *612
required:
- action
- personal_access_token_request
@@ -135274,7 +134606,7 @@ x-webhooks:
id:
description: Unique identifier of the webhook.
type: integer
- last_response: *653
+ last_response: *648
name:
description: The type of webhook. The only valid value is 'web'.
type: string
@@ -135306,8 +134638,8 @@ x-webhooks:
hook_id:
description: The ID of the webhook that triggered the ping.
type: integer
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
zen:
description: Random string of GitHub zen.
@@ -135562,10 +134894,10 @@ x-webhooks:
- from
required:
- note
- enterprise: *616
- installation: *617
- organization: *618
- project_card: &654
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project_card: &649
title: Project Card
type: object
properties:
@@ -135684,7 +135016,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -135775,11 +135107,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- project_card: *654
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project_card: *649
+ repository: *614
sender: *19
required:
- action
@@ -135869,9 +135201,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
project_card:
title: Project Card
type: object
@@ -135999,8 +135331,8 @@ x-webhooks:
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *647
- required: *648
+ properties: *642
+ required: *643
nullable: true
sender: *19
required:
@@ -136104,11 +135436,11 @@ x-webhooks:
- from
required:
- note
- enterprise: *616
- installation: *617
- organization: *618
- project_card: *654
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project_card: *649
+ repository: *614
sender: *19
required:
- action
@@ -136212,9 +135544,9 @@ x-webhooks:
- from
required:
- column_id
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
project_card:
allOf:
- title: Project Card
@@ -136404,7 +135736,7 @@ x-webhooks:
type: string
required:
- after_id
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -136494,10 +135826,10 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *616
- installation: *617
- organization: *618
- project: &656
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project: &651
title: Project
type: object
properties:
@@ -136621,7 +135953,7 @@ x-webhooks:
- creator
- created_at
- updated_at
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -136711,10 +136043,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- project_column: &655
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project_column: &650
title: Project Column
type: object
properties:
@@ -136753,7 +136085,7 @@ x-webhooks:
- name
- created_at
- updated_at
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -136842,18 +136174,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
- project_column: *655
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project_column: *650
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *647
- required: *648
+ properties: *642
+ required: *643
nullable: true
sender: *19
required:
@@ -136953,11 +136285,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
- organization: *618
- project_column: *655
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project_column: *650
+ repository: *614
sender: *19
required:
- action
@@ -137047,11 +136379,11 @@ x-webhooks:
type: string
enum:
- moved
- enterprise: *616
- installation: *617
- organization: *618
- project_column: *655
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project_column: *650
+ repository: *614
sender: *19
required:
- action
@@ -137141,11 +136473,11 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- project: *656
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project: *651
+ repository: *614
sender: *19
required:
- action
@@ -137235,18 +136567,18 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
- project: *656
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project: *651
repository:
title: Repository
description: |-
The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
when the event occurs from activity in a repository.
type: object
- properties: *647
- required: *648
+ properties: *642
+ required: *643
nullable: true
sender: *19
required:
@@ -137358,11 +136690,11 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
- organization: *618
- project: *656
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project: *651
+ repository: *614
sender: *19
required:
- action
@@ -137451,11 +136783,11 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *616
- installation: *617
- organization: *618
- project: *656
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ project: *651
+ repository: *614
sender: *19
required:
- action
@@ -137546,9 +136878,9 @@ x-webhooks:
type: string
enum:
- closed
- installation: *617
- organization: *618
- projects_v2: &657
+ installation: *612
+ organization: *613
+ projects_v2: &652
title: Projects v2 Project
description: A projects v2 project
type: object
@@ -137780,9 +137112,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *617
- organization: *618
- projects_v2: *657
+ installation: *612
+ organization: *613
+ projects_v2: *652
sender: *19
required:
- action
@@ -137873,9 +137205,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *617
- organization: *618
- projects_v2: *657
+ installation: *612
+ organization: *613
+ projects_v2: *652
sender: *19
required:
- action
@@ -138002,9 +137334,9 @@ x-webhooks:
type: string
to:
type: string
- installation: *617
- organization: *618
- projects_v2: *657
+ installation: *612
+ organization: *613
+ projects_v2: *652
sender: *19
required:
- action
@@ -138097,7 +137429,7 @@ x-webhooks:
type: string
enum:
- archived
- changes: &661
+ changes: &656
type: object
properties:
archived_at:
@@ -138111,9 +137443,9 @@ x-webhooks:
type: string
nullable: true
format: date-time
- installation: *617
- organization: *618
- projects_v2_item: &658
+ installation: *612
+ organization: *613
+ projects_v2_item: &653
title: Projects v2 Item
description: An item belonging to a project
type: object
@@ -138265,9 +137597,9 @@ x-webhooks:
nullable: true
to:
type: string
- installation: *617
- organization: *618
- projects_v2_item: *658
+ installation: *612
+ organization: *613
+ projects_v2_item: *653
sender: *19
required:
- action
@@ -138359,9 +137691,9 @@ x-webhooks:
type: string
enum:
- created
- installation: *617
- organization: *618
- projects_v2_item: *658
+ installation: *612
+ organization: *613
+ projects_v2_item: *653
sender: *19
required:
- action
@@ -138452,9 +137784,9 @@ x-webhooks:
type: string
enum:
- deleted
- installation: *617
- organization: *618
- projects_v2_item: *658
+ installation: *612
+ organization: *613
+ projects_v2_item: *653
sender: *19
required:
- action
@@ -138570,7 +137902,7 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - &659
+ - &654
title: Projects v2 Single Select Option
description: An option for a single select field
type: object
@@ -138592,7 +137924,7 @@ x-webhooks:
required:
- id
- name
- - &660
+ - &655
title: Projects v2 Iteration Setting
description: An iteration setting for an iteration field
type: object
@@ -138626,8 +137958,8 @@ x-webhooks:
oneOf:
- type: string
- type: integer
- - *659
- - *660
+ - *654
+ - *655
required:
- field_value
- type: object
@@ -138643,9 +137975,9 @@ x-webhooks:
nullable: true
required:
- body
- installation: *617
- organization: *618
- projects_v2_item: *658
+ installation: *612
+ organization: *613
+ projects_v2_item: *653
sender: *19
required:
- action
@@ -138750,9 +138082,9 @@ x-webhooks:
to:
type: string
nullable: true
- installation: *617
- organization: *618
- projects_v2_item: *658
+ installation: *612
+ organization: *613
+ projects_v2_item: *653
sender: *19
required:
- action
@@ -138845,10 +138177,10 @@ x-webhooks:
type: string
enum:
- restored
- changes: *661
- installation: *617
- organization: *618
- projects_v2_item: *658
+ changes: *656
+ installation: *612
+ organization: *613
+ projects_v2_item: *653
sender: *19
required:
- action
@@ -138940,9 +138272,9 @@ x-webhooks:
type: string
enum:
- reopened
- installation: *617
- organization: *618
- projects_v2: *657
+ installation: *612
+ organization: *613
+ projects_v2: *652
sender: *19
required:
- action
@@ -139023,10 +138355,10 @@ x-webhooks:
title: public event
type: object
properties:
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- repository
@@ -139113,13 +138445,13 @@ x-webhooks:
type: string
enum:
- assigned
- assignee: *638
- enterprise: *616
- installation: *617
- number: &662
+ assignee: *633
+ enterprise: *611
+ installation: *612
+ number: &657
description: The pull request number.
type: integer
- organization: *618
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -141402,7 +140734,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -141494,11 +140826,11 @@ x-webhooks:
type: string
enum:
- auto_merge_disabled
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
number:
type: integer
- organization: *618
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -143776,7 +143108,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -143868,11 +143200,11 @@ x-webhooks:
type: string
enum:
- auto_merge_enabled
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
number:
type: integer
- organization: *618
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -146150,7 +145482,7 @@ x-webhooks:
- draft
reason:
type: string
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -146242,11 +145574,11 @@ x-webhooks:
type: string
enum:
- closed
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
- pull_request: &663
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
+ pull_request: &658
allOf:
- *117
- type: object
@@ -146310,7 +145642,7 @@ x-webhooks:
Please use `squash_merge_commit_title` instead.**
type: boolean
default: false
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -146401,12 +145733,12 @@ x-webhooks:
type: string
enum:
- converted_to_draft
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
- pull_request: *663
- repository: *619
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
+ pull_request: *658
+ repository: *614
sender: *19
required:
- action
@@ -146496,11 +145828,11 @@ x-webhooks:
type: string
enum:
- demilestoned
- enterprise: *616
- milestone: *488
- number: *662
- organization: *618
- pull_request: &664
+ enterprise: *611
+ milestone: *485
+ number: *657
+ organization: *613
+ pull_request: &659
title: Pull Request
type: object
properties:
@@ -148763,7 +148095,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -148895,12 +148227,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
- pull_request: *663
- repository: *619
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
+ pull_request: *658
+ repository: *614
sender: *19
required:
- action
@@ -148990,11 +148322,11 @@ x-webhooks:
type: string
enum:
- labeled
- enterprise: *616
- installation: *617
- label: *637
- number: *662
- organization: *618
+ enterprise: *611
+ installation: *612
+ label: *632
+ number: *657
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -151276,7 +150608,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -151367,10 +150699,10 @@ x-webhooks:
type: string
enum:
- locked
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -153650,7 +152982,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -153740,12 +153072,12 @@ x-webhooks:
type: string
enum:
- milestoned
- enterprise: *616
- milestone: *488
- number: *662
- organization: *618
- pull_request: *664
- repository: *619
+ enterprise: *611
+ milestone: *485
+ number: *657
+ organization: *613
+ pull_request: *659
+ repository: *614
sender: *19
required:
- action
@@ -153834,12 +153166,12 @@ x-webhooks:
type: string
enum:
- opened
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
- pull_request: *663
- repository: *619
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
+ pull_request: *658
+ repository: *614
sender: *19
required:
- action
@@ -153930,12 +153262,12 @@ x-webhooks:
type: string
enum:
- ready_for_review
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
- pull_request: *663
- repository: *619
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
+ pull_request: *658
+ repository: *614
sender: *19
required:
- action
@@ -154025,12 +153357,12 @@ x-webhooks:
type: string
enum:
- reopened
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
- pull_request: *663
- repository: *619
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
+ pull_request: *658
+ repository: *614
sender: *19
required:
- action
@@ -154406,9 +153738,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
pull_request:
type: object
properties:
@@ -156578,7 +155910,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -156668,7 +156000,7 @@ x-webhooks:
type: string
enum:
- deleted
- comment: &666
+ comment: &661
title: Pull Request Review Comment
description: The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request)
itself.
@@ -156953,9 +156285,9 @@ x-webhooks:
- start_side
- side
- reactions
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
pull_request:
type: object
properties:
@@ -159113,7 +158445,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -159203,11 +158535,11 @@ x-webhooks:
type: string
enum:
- edited
- changes: *665
- comment: *666
- enterprise: *616
- installation: *617
- organization: *618
+ changes: *660
+ comment: *661
+ enterprise: *611
+ installation: *612
+ organization: *613
pull_request:
type: object
properties:
@@ -161368,7 +160700,7 @@ x-webhooks:
- _links
- author_association
- active_lock_reason
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -161459,9 +160791,9 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
pull_request:
title: Simple Pull Request
type: object
@@ -163634,7 +162966,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *619
+ repository: *614
review:
description: The review that was affected.
type: object
@@ -163891,9 +163223,9 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
pull_request:
title: Simple Pull Request
type: object
@@ -165947,8 +165279,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *619
- review: &667
+ repository: *614
+ review: &662
description: The review that was affected.
type: object
properties:
@@ -166191,12 +165523,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
number:
description: The pull request number.
type: integer
- organization: *618
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -168479,7 +167811,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
requested_reviewer:
title: User
type: object
@@ -168563,12 +167895,12 @@ x-webhooks:
type: string
enum:
- review_request_removed
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
number:
description: The pull request number.
type: integer
- organization: *618
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -170858,7 +170190,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -171060,12 +170392,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
number:
description: The pull request number.
type: integer
- organization: *618
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -173350,7 +172682,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
requested_reviewer:
title: User
type: object
@@ -173435,12 +172767,12 @@ x-webhooks:
type: string
enum:
- review_requested
- enterprise: *616
- installation: *617
+ enterprise: *611
+ installation: *612
number:
description: The pull request number.
type: integer
- organization: *618
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -175716,7 +175048,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
requested_team:
title: Team
description: Groups of organization members that gives permissions
@@ -175907,9 +175239,9 @@ x-webhooks:
type: string
enum:
- submitted
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
pull_request:
title: Simple Pull Request
type: object
@@ -178084,8 +177416,8 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *619
- review: *667
+ repository: *614
+ review: *662
sender: *19
required:
- action
@@ -178175,9 +177507,9 @@ x-webhooks:
type: string
enum:
- resolved
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
pull_request:
title: Simple Pull Request
type: object
@@ -180247,7 +179579,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *619
+ repository: *614
sender: *19
thread:
type: object
@@ -180644,9 +179976,9 @@ x-webhooks:
type: string
enum:
- unresolved
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
pull_request:
title: Simple Pull Request
type: object
@@ -182702,7 +182034,7 @@ x-webhooks:
- author_association
- auto_merge
- active_lock_reason
- repository: *619
+ repository: *614
sender: *19
thread:
type: object
@@ -183102,10 +182434,10 @@ x-webhooks:
type: string
before:
type: string
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -185376,7 +184708,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -185468,11 +184800,11 @@ x-webhooks:
type: string
enum:
- unassigned
- assignee: *668
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
+ assignee: *663
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -187755,7 +187087,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -187844,11 +187176,11 @@ x-webhooks:
type: string
enum:
- unlabeled
- enterprise: *616
- installation: *617
- label: *637
- number: *662
- organization: *618
+ enterprise: *611
+ installation: *612
+ label: *632
+ number: *657
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -190121,7 +189453,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -190212,10 +189544,10 @@ x-webhooks:
type: string
enum:
- unlocked
- enterprise: *616
- installation: *617
- number: *662
- organization: *618
+ enterprise: *611
+ installation: *612
+ number: *657
+ organization: *613
pull_request:
title: Pull Request
type: object
@@ -192480,7 +191812,7 @@ x-webhooks:
- auto_merge
- active_lock_reason
- draft
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -192690,7 +192022,7 @@ x-webhooks:
deleted:
description: Whether this push deleted the `ref`.
type: boolean
- enterprise: *616
+ enterprise: *611
forced:
description: Whether this push was a force push of the `ref`.
type: boolean
@@ -192782,8 +192114,8 @@ x-webhooks:
- url
- author
- committer
- installation: *617
- organization: *618
+ installation: *612
+ organization: *613
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -193368,9 +192700,9 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
registry_package:
type: object
properties:
@@ -193816,7 +193148,7 @@ x-webhooks:
type: string
rubygems_metadata:
type: array
- items: *651
+ items: *646
summary:
type: string
tag_name:
@@ -193870,7 +193202,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -193958,9 +193290,9 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
registry_package:
type: object
properties:
@@ -194268,7 +193600,7 @@ x-webhooks:
- published_at
rubygems_metadata:
type: array
- items: *651
+ items: *646
summary:
type: string
tag_name:
@@ -194317,7 +193649,7 @@ x-webhooks:
- owner
- package_version
- registry
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -194404,10 +193736,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- release: &669
+ enterprise: *611
+ installation: *612
+ organization: *613
+ release: &664
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
object.
@@ -194725,7 +194057,7 @@ x-webhooks:
- updated_at
- zipball_url
- body
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -194812,11 +194144,11 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
- release: *669
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ release: *664
+ repository: *614
sender: *19
required:
- action
@@ -194943,11 +194275,11 @@ x-webhooks:
type: boolean
required:
- to
- enterprise: *616
- installation: *617
- organization: *618
- release: *669
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ release: *664
+ repository: *614
sender: *19
required:
- action
@@ -195035,9 +194367,9 @@ x-webhooks:
type: string
enum:
- prereleased
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
release:
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
@@ -195359,7 +194691,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -195445,10 +194777,10 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *616
- installation: *617
- organization: *618
- release: &670
+ enterprise: *611
+ installation: *612
+ organization: *613
+ release: &665
title: Release
description: The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release)
object.
@@ -195767,7 +195099,7 @@ x-webhooks:
type: string
nullable: true
format: uri
- repository: *619
+ repository: *614
sender: *19
required:
- action
@@ -195853,11 +195185,11 @@ x-webhooks:
type: string
enum:
- released
- enterprise: *616
- installation: *617
- organization: *618
- release: *669
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ release: *664
+ repository: *614
sender: *19
required:
- action
@@ -195943,11 +195275,11 @@ x-webhooks:
type: string
enum:
- unpublished
- enterprise: *616
- installation: *617
- organization: *618
- release: *670
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ release: *665
+ repository: *614
sender: *19
required:
- action
@@ -196033,10 +195365,10 @@ x-webhooks:
type: string
enum:
- anonymous_access_disabled
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196121,10 +195453,10 @@ x-webhooks:
type: string
enum:
- anonymous_access_enabled
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196209,10 +195541,10 @@ x-webhooks:
type: string
enum:
- archived
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196299,10 +195631,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196390,10 +195722,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196487,10 +195819,10 @@ x-webhooks:
additionalProperties: true
description: The `client_payload` that was specified in the `POST
/repos/{owner}/{repo}/dispatches` request body.
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196612,10 +195944,10 @@ x-webhooks:
nullable: true
items:
type: string
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196703,10 +196035,10 @@ x-webhooks:
type: string
enum:
- privatized
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196793,10 +196125,10 @@ x-webhooks:
type: string
enum:
- publicized
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196900,10 +196232,10 @@ x-webhooks:
- name
required:
- repository
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -196983,10 +196315,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
repository_ruleset: *273
sender: *19
required:
@@ -197065,10 +196397,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
repository_ruleset: *273
sender: *19
required:
@@ -197147,10 +196479,10 @@ x-webhooks:
type: string
enum:
- edited
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
repository_ruleset: *273
changes:
type: object
@@ -197212,16 +196544,16 @@ x-webhooks:
properties:
added:
type: array
- items: *526
+ items: *523
deleted:
type: array
- items: *526
+ items: *523
updated:
type: array
items:
type: object
properties:
- rule: *526
+ rule: *523
changes:
type: object
properties:
@@ -197465,10 +196797,10 @@ x-webhooks:
- from
required:
- owner
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -197556,10 +196888,10 @@ x-webhooks:
type: string
enum:
- unarchived
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -197647,7 +196979,7 @@ x-webhooks:
type: string
enum:
- create
- alert: &671
+ alert: &666
title: Repository Vulnerability Alert Alert
description: The security alert of the vulnerable dependency.
type: object
@@ -197768,10 +197100,10 @@ x-webhooks:
type: string
enum:
- open
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -197987,10 +197319,10 @@ x-webhooks:
type: string
enum:
- dismissed
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -198078,11 +197410,11 @@ x-webhooks:
type: string
enum:
- reopen
- alert: *671
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ alert: *666
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -198291,10 +197623,10 @@ x-webhooks:
enum:
- fixed
- open
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -198382,7 +197714,7 @@ x-webhooks:
type: string
enum:
- created
- alert: &672
+ alert: &667
type: object
properties:
number: *93
@@ -198462,10 +197794,10 @@ x-webhooks:
description: 'The time that push protection was bypassed in
ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
nullable: true
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -198556,11 +197888,11 @@ x-webhooks:
type: string
enum:
- created
- alert: *672
- installation: *617
- location: *673
- organization: *618
- repository: *619
+ alert: *667
+ installation: *612
+ location: *668
+ organization: *613
+ repository: *614
sender: *19
required:
- location
@@ -198803,11 +198135,11 @@ x-webhooks:
type: string
enum:
- reopened
- alert: *672
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ alert: *667
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -198895,11 +198227,11 @@ x-webhooks:
type: string
enum:
- resolved
- alert: *672
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ alert: *667
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -198987,11 +198319,11 @@ x-webhooks:
type: string
enum:
- validated
- alert: *672
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ alert: *667
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -199077,11 +198409,11 @@ x-webhooks:
type: string
enum:
- published
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- security_advisory: &674
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ security_advisory: &669
description: The details of the security advisory, including summary,
description, and severity.
type: object
@@ -199274,11 +198606,11 @@ x-webhooks:
type: string
enum:
- updated
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
- security_advisory: *674
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
+ security_advisory: *669
sender: *19
required:
- action
@@ -199361,10 +198693,10 @@ x-webhooks:
type: string
enum:
- withdrawn
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
security_advisory:
description: The details of the security advisory, including summary,
description, and severity.
@@ -199559,10 +198891,10 @@ x-webhooks:
type: object
properties:
security_and_analysis: *251
- enterprise: *616
- installation: *617
- organization: *618
- repository: *310
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *307
sender: *19
required:
- changes
@@ -199650,12 +198982,12 @@ x-webhooks:
type: string
enum:
- cancelled
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- sponsorship: &675
+ sponsorship: &670
type: object
properties:
created_at:
@@ -199966,12 +199298,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- sponsorship: *675
+ sponsorship: *670
required:
- action
- sponsorship
@@ -200069,12 +199401,12 @@ x-webhooks:
type: string
required:
- from
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- sponsorship: *675
+ sponsorship: *670
required:
- action
- changes
@@ -200161,17 +199493,17 @@ x-webhooks:
type: string
enum:
- pending_cancellation
- effective_date: &676
+ effective_date: &671
description: The `pending_cancellation` and `pending_tier_change`
event types will include the date the cancellation or tier change
will take effect.
type: string
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- sponsorship: *675
+ sponsorship: *670
required:
- action
- sponsorship
@@ -200255,7 +199587,7 @@ x-webhooks:
type: string
enum:
- pending_tier_change
- changes: &677
+ changes: &672
type: object
properties:
tier:
@@ -200299,13 +199631,13 @@ x-webhooks:
- from
required:
- tier
- effective_date: *676
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ effective_date: *671
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- sponsorship: *675
+ sponsorship: *670
required:
- action
- changes
@@ -200392,13 +199724,13 @@ x-webhooks:
type: string
enum:
- tier_changed
- changes: *677
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ changes: *672
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- sponsorship: *675
+ sponsorship: *670
required:
- action
- changes
@@ -200482,10 +199814,10 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -200578,10 +199910,10 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
starred_at:
description: 'The time the star was created. This is a timestamp
@@ -201007,15 +200339,15 @@ x-webhooks:
status.
type: string
nullable: true
- enterprise: *616
+ enterprise: *611
id:
description: The unique identifier of the status.
type: integer
- installation: *617
+ installation: *612
name:
type: string
- organization: *618
- repository: *619
+ organization: *613
+ repository: *614
sender: *19
sha:
description: The Commit SHA.
@@ -201127,12 +200459,12 @@ x-webhooks:
title: team_add event
type: object
properties:
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- team: &678
+ team: &673
title: Team
description: Groups of organization members that gives permissions
on specified repositories.
@@ -201365,9 +200697,9 @@ x-webhooks:
type: string
enum:
- added_to_repository
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
repository:
title: Repository
description: A git repository
@@ -201825,7 +201157,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *678
+ team: *673
required:
- action
- team
@@ -201911,9 +201243,9 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
repository:
title: Repository
description: A git repository
@@ -202371,7 +201703,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *678
+ team: *673
required:
- action
- team
@@ -202458,9 +201790,9 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
repository:
title: Repository
description: A git repository
@@ -202918,7 +202250,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *678
+ team: *673
required:
- action
- team
@@ -203072,9 +202404,9 @@ x-webhooks:
- from
required:
- permissions
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
repository:
title: Repository
description: A git repository
@@ -203532,7 +202864,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *678
+ team: *673
required:
- action
- changes
@@ -203620,9 +202952,9 @@ x-webhooks:
type: string
enum:
- removed_from_repository
- enterprise: *616
- installation: *617
- organization: *618
+ enterprise: *611
+ installation: *612
+ organization: *613
repository:
title: Repository
description: A git repository
@@ -204080,7 +203412,7 @@ x-webhooks:
- topics
- visibility
sender: *19
- team: *678
+ team: *673
required:
- action
- team
@@ -204163,12 +203495,12 @@ x-webhooks:
type: string
enum:
- created
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- user: *638
+ user: *633
required:
- action
responses:
@@ -204246,12 +203578,12 @@ x-webhooks:
type: string
enum:
- deleted
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- user: *638
+ user: *633
required:
- action
responses:
@@ -204332,10 +203664,10 @@ x-webhooks:
type: string
enum:
- started
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
required:
- action
@@ -204418,16 +203750,16 @@ x-webhooks:
title: workflow_dispatch event
type: object
properties:
- enterprise: *616
+ enterprise: *611
inputs:
type: object
nullable: true
additionalProperties: true
- installation: *617
- organization: *618
+ installation: *612
+ organization: *613
ref:
type: string
- repository: *619
+ repository: *614
sender: *19
workflow:
type: string
@@ -204519,10 +203851,10 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
workflow_job:
allOf:
@@ -204759,7 +204091,7 @@ x-webhooks:
type: string
required:
- conclusion
- deployment: *425
+ deployment: *422
required:
- action
- repository
@@ -204848,10 +204180,10 @@ x-webhooks:
type: string
enum:
- in_progress
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
workflow_job:
allOf:
@@ -205111,7 +204443,7 @@ x-webhooks:
required:
- status
- steps
- deployment: *425
+ deployment: *422
required:
- action
- repository
@@ -205200,10 +204532,10 @@ x-webhooks:
type: string
enum:
- queued
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
workflow_job:
type: object
@@ -205338,7 +204670,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *425
+ deployment: *422
required:
- action
- repository
@@ -205427,10 +204759,10 @@ x-webhooks:
type: string
enum:
- waiting
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
workflow_job:
type: object
@@ -205566,7 +204898,7 @@ x-webhooks:
- workflow_name
- head_branch
- created_at
- deployment: *425
+ deployment: *422
required:
- action
- repository
@@ -205656,12 +204988,12 @@ x-webhooks:
type: string
enum:
- completed
- enterprise: *616
- installation: *617
- organization: *618
- repository: *619
+ enterprise: *611
+ installation: *612
+ organization: *613
+ repository: *614
sender: *19
- workflow: *633
+ workflow: *628
workflow_run:
title: Workflow Run
type: object
@@ -206670,1{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}