Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "$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", @@ -298853,158 +298115,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": { @@ -320040,15 +319150,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-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 66da12ce3..1ebfd4466 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -21111,231 +21111,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 @@ -47378,235 +47153,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) @@ -88329,105 +87875,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: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - body: - description: The main text of the discussion. - type: string - examples: - - Please suggest improvements to our workflow in comments. - body_html: - type: string - examples: - - "Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted to team - members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: - "$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 @@ -221027,144 +220474,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: @@ -239354,13 +238663,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index f322ee590..063ea4e03 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -29229,313 +29229,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", @@ -65341,304 +65034,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)", @@ -121745,139 +121140,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": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "$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", @@ -298853,158 +298115,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": { @@ -320040,15 +319150,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 66da12ce3..1ebfd4466 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -21111,231 +21111,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 @@ -47378,235 +47153,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) @@ -88329,105 +87875,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: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - body: - description: The main text of the discussion. - type: string - examples: - - Please suggest improvements to our workflow in comments. - body_html: - type: string - examples: - - "Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted to team - members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: - "$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 @@ -221027,144 +220474,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: @@ -239354,13 +238663,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index e852876e8..407ba2157 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -229707,17 +229707,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": [ { @@ -229739,17 +229739,376 @@ } }, { - "name": "direction", - "description": "The direction to sort the results by.", + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "Hi! This is an area for us to collaborate as a team
" + 1 ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "node_id": { "type": "string", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "MDQ6VXNlcjE=" ] }, - "created_at": { + "avatar_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://github.com/images/error/octocat_happy.gif" ] }, - "last_edited_at": { + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" + "https://github.com/octocat" ] }, - "node_id": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "https://api.github.com/users/octocat/followers" ] }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", + "following_url": { + "type": "string", "examples": [ - 42 + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", + "gists_url": { + "type": "string", "examples": [ - true + "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.", - "type": "boolean", + "starred_url": { + "type": "string", "examples": [ - true + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "team_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "https://api.github.com/users/octocat/subscriptions" ] }, - "title": { - "description": "The title of the discussion.", + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "How can we improve our workflow?" + "https://api.github.com/users/octocat/orgs" ] }, - "updated_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/users/octocat/repos" ] }, - "url": { + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "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", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", + "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" ] } @@ -230136,52 +230310,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 } ] } @@ -230202,19 +230348,126 @@ "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/rest/teams/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "type": "string", + "examples": [ + "member" + ] + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" } }, - "post": { - "summary": "Create a discussion", - "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.", + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], - "operationId": "teams/create-discussion-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#create-a-discussion" + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -230234,39 +230487,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" } } } @@ -230274,430 +230528,83 @@ } }, "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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { + "url": { "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "format": "uri" }, - "last_edited_at": { - "type": [ - "string", - "null" + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { + "default": "member", "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "member" ] }, - "url": { + "state": { + "description": "The state of the user's membership in the team.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/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" } } } } } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "discussions" + "subcategory": "members" } - } - }, - "/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.", + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], - "operationId": "teams/get-discussion-in-org", + "operationId": "teams/remove-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#remove-team-membership-for-a-user" }, "parameters": [ { @@ -230719,437 +230626,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": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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 - } - } - } - } - } - } + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden if team synchronization is set up" } }, "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.", + } + }, + "/orgs/{org}/teams/{team_slug}/repos": { + "get": { + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/update-discussion-in-org", + "operationId": "teams/list-repos-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/teams#list-team-repositories" }, "parameters": [ { @@ -231171,604 +230683,62 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 30 } - } - ], - "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" - } - } - } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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 + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - "body": "Hi! This is an area 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", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" ] }, - "failed_reason": { - "type": [ - "string", - "null" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" ] }, - "inviter": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -231936,337 +230906,659 @@ "url" ] }, - "team_count": { - "type": "integer" + "private": { + "type": "boolean" }, - "node_id": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "https://github.com/octocat/Hello-World" ] }, - "invitation_teams_url": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "invitation_source": { + "archive_url": { "type": "string", "examples": [ - "\"member\"" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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": "Hi! This is an area for us to collaborate as a team
" + 42 ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "node_id": { "type": "string", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "MDQ6VGVhbTE=" ] }, - "created_at": { + "url": { + "description": "URL for the team", "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1" ] }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" + "https://github.com/orgs/rails/teams/core" ] }, - "node_id": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "Developers" ] }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", + "slug": { + "type": "string", "examples": [ - 42 + "justice-league" ] }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - true + "A great team." ] }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], "examples": [ - true + "closed" ] }, - "team_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "notifications_enabled" ] }, - "title": { - "description": "The title of the discussion.", + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "How can we improve our workflow?" + "push" ] }, - "updated_at": { + "members_url": { "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "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": { + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -624035,472 +619371,751 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -624508,361 +620123,763 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -624871,20 +620888,20 @@ "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true }, "delete": { - "summary": "Delete a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Delete a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], - "operationId": "teams/delete-discussion-legacy", + "operationId": "teams/delete-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy" + "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy" }, "parameters": [ { @@ -624895,20 +620912,112 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -624917,7 +621026,7 @@ "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index c5ea72e87..f136965b0 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1071,7 +1071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &618 + - &615 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -9170,7 +9170,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 - - &457 + - &454 name: has in: query description: |- @@ -9290,7 +9290,7 @@ paths: - direct - transitive - - security_advisory: &458 + security_advisory: &455 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9558,7 +9558,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &459 + auto_dismissed_at: &456 type: - string - 'null' @@ -9566,7 +9566,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &460 + dismissal_request: &457 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -10957,7 +10957,7 @@ paths: properties: action: type: string - discussion: &711 + discussion: &706 title: Discussion description: A Discussion in a repository. type: object @@ -11743,7 +11743,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &630 + sub_issues_summary: &627 title: Sub-issues Summary type: object properties: @@ -11764,7 +11764,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &631 + issue_dependencies_summary: &628 title: Issue Dependencies Summary type: object properties: @@ -11783,7 +11783,7 @@ paths: - total_blocking issue_field_values: type: array - items: &632 + items: &629 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11896,7 +11896,7 @@ paths: action: type: string issue: *71 - comment: &507 + comment: &504 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -12619,7 +12619,7 @@ paths: type: string release: allOf: - - &563 + - &560 title: Release description: A release. type: object @@ -12701,7 +12701,7 @@ paths: author: *4 assets: type: array - items: &564 + items: &561 title: Release Asset description: Data related to a release. type: object @@ -13304,7 +13304,7 @@ paths: url: type: string format: uri - user: &640 + user: &635 title: Public User description: Public User type: object @@ -16661,14 +16661,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &311 + - &308 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &312 + - &309 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16730,7 +16730,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &315 + '301': &312 description: Moved permanently content: application/json: @@ -16752,7 +16752,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &537 + - &534 name: all description: If `true`, show notifications marked as read. in: query @@ -16760,7 +16760,7 @@ paths: schema: type: boolean default: false - - &538 + - &535 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16770,7 +16770,7 @@ paths: type: boolean default: false - *77 - - &539 + - &536 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: @@ -17306,7 +17306,7 @@ paths: - url - subscription_url examples: - default: &540 + default: &537 value: - id: '1' repository: @@ -18333,7 +18333,7 @@ paths: - property_name - value examples: - default: &546 + default: &543 value: - property_name: environment value: production @@ -18383,7 +18383,7 @@ paths: required: - properties examples: - default: &547 + default: &544 value: properties: - property_name: environment @@ -18957,7 +18957,7 @@ paths: required: false schema: type: string - - &688 + - &683 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19103,7 +19103,7 @@ paths: parameters: - *66 - *108 - - &689 + - &684 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 @@ -19215,7 +19215,7 @@ paths: - *108 - *110 - *109 - - &690 + - &685 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19223,7 +19223,7 @@ paths: schema: type: string - *111 - - &691 + - &686 name: sku description: The SKU to query for usage. in: query @@ -20202,7 +20202,7 @@ paths: type: integer repository_cache_usages: type: array - items: &322 + items: &319 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21440,7 +21440,7 @@ paths: - all - local_only - selected - selected_actions_url: &328 + selected_actions_url: &325 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` @@ -21523,7 +21523,7 @@ paths: description: Response content: application/json: - schema: &332 + schema: &329 type: object properties: days: @@ -21565,7 +21565,7 @@ paths: required: true content: application/json: - schema: &333 + schema: &330 type: object properties: days: @@ -21622,7 +21622,7 @@ paths: required: - approval_policy examples: - default: &334 + default: &331 value: approval_policy: first_time_contributors '404': *6 @@ -21681,7 +21681,7 @@ paths: description: Response content: application/json: - schema: &335 + schema: &332 type: object required: - run_workflows_from_fork_pull_requests @@ -21735,7 +21735,7 @@ paths: required: true content: application/json: - schema: &336 + schema: &333 type: object required: - run_workflows_from_fork_pull_requests @@ -22370,7 +22370,7 @@ paths: description: Response content: application/json: - schema: &337 + schema: &334 type: object properties: default_workflow_permissions: &138 @@ -22421,7 +22421,7 @@ paths: required: false content: application/json: - schema: &338 + schema: &335 type: object properties: default_workflow_permissions: *138 @@ -22914,7 +22914,7 @@ paths: type: array items: *145 examples: - default: &643 + default: &638 value: total_count: 1 repositories: @@ -23561,7 +23561,7 @@ paths: application/json: schema: type: array - items: &339 + items: &336 title: Runner Application description: Runner Application type: object @@ -23586,7 +23586,7 @@ paths: - download_url - filename examples: - default: &340 + default: &337 value: - os: osx architecture: x64 @@ -23672,7 +23672,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &341 + '201': &338 description: Response content: application/json: @@ -23787,7 +23787,7 @@ paths: - token - expires_at examples: - default: &342 + default: &339 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23826,7 +23826,7 @@ paths: application/json: schema: *149 examples: - default: &343 + default: &340 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23860,7 +23860,7 @@ paths: application/json: schema: *147 examples: - default: &344 + default: &341 value: id: 23 name: MBP @@ -24086,7 +24086,7 @@ paths: - *66 - *146 responses: - '200': &345 + '200': &342 description: Response content: application/json: @@ -24143,7 +24143,7 @@ paths: parameters: - *66 - *146 - - &346 + - &343 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24275,7 +24275,7 @@ paths: description: Response content: application/json: - schema: &358 + schema: &355 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24310,7 +24310,7 @@ paths: - key_id - key examples: - default: &359 + default: &356 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24723,7 +24723,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *66 - - &327 + - &324 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)." @@ -25885,12 +25885,12 @@ paths: required: - subject_digests examples: - default: &670 + default: &665 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &671 + withPredicateType: &666 value: subject_digests: - sha256:abc123 @@ -25949,7 +25949,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &672 + default: &667 value: attestations_subject_digests: - sha256:abc: @@ -26298,7 +26298,7 @@ paths: initiator: type: string examples: - default: &372 + default: &369 value: attestations: - bundle: @@ -27254,7 +27254,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *66 - - &396 + - &393 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`, @@ -27264,7 +27264,7 @@ paths: schema: &170 type: string description: The name of the tool used to generate the code scanning analysis. - - &397 + - &394 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 @@ -27288,7 +27288,7 @@ paths: be returned. in: query required: false - schema: &399 + schema: &396 type: string description: State of a code scanning alert. enum: @@ -27311,7 +27311,7 @@ paths: be returned. in: query required: false - schema: &400 + schema: &397 type: string description: Severity of a code scanning alert. enum: @@ -27345,7 +27345,7 @@ paths: updated_at: *165 url: *166 html_url: *167 - instances_url: &401 + instances_url: &398 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -27367,7 +27367,7 @@ paths: - type: 'null' - *4 dismissed_at: *169 - dismissed_reason: &402 + dismissed_reason: &399 type: - string - 'null' @@ -27378,14 +27378,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &403 + dismissed_comment: &400 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &404 + rule: &401 type: object properties: id: @@ -27446,7 +27446,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &405 + tool: &402 type: object properties: name: *170 @@ -27457,26 +27457,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *171 - most_recent_instance: &406 + most_recent_instance: &403 type: object properties: - ref: &398 + ref: &395 type: string description: |- The Git reference, formatted as `refs/pull/Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, - this update operation will be rejected if the given version - does not match the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned - for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted - to team members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *73 - 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: &634 - value: - - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: *57 - 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: - - *66 - - *67 - 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: *307 - examples: - default: &308 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *66 - - *67 - - &309 - 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: *307 - examples: - default: *308 - 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: - - *66 - - *67 - - *309 - 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: *307 - examples: - default: &635 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *66 - - *67 - - *309 - 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 @@ -48797,7 +48339,7 @@ paths: description: Response content: application/json: - schema: &310 + schema: &307 title: Team Membership description: Team Membership type: object @@ -48825,7 +48367,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &636 + response-if-user-is-a-team-maintainer: &631 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -48888,9 +48430,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *307 examples: - response-if-users-membership-with-team-is-now-pending: &637 + response-if-users-membership-with-team-is-now-pending: &632 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -48997,14 +48539,14 @@ paths: parameters: - *66 - *67 - - *311 - - *312 + - *308 + - *309 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &638 + schema: &633 title: Team Repository description: A team's access to a repository. type: object @@ -49647,8 +49189,8 @@ paths: parameters: - *66 - *67 - - *311 - - *312 + - *308 + - *309 requestBody: required: false content: @@ -49695,8 +49237,8 @@ paths: parameters: - *66 - *67 - - *311 - - *312 + - *308 + - *309 responses: '204': description: Response @@ -49733,7 +49275,7 @@ paths: type: array items: *180 examples: - response-if-child-teams-exist: &639 + response-if-child-teams-exist: &634 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -49887,7 +49429,7 @@ paths: resources: type: object properties: - core: &313 + core: &310 title: Rate Limit type: object properties: @@ -49904,21 +49446,21 @@ paths: - remaining - reset - used - graphql: *313 - search: *313 - code_search: *313 - source_import: *313 - integration_manifest: *313 - code_scanning_upload: *313 - actions_runner_registration: *313 - scim: *313 - dependency_snapshots: *313 - dependency_sbom: *313 - code_scanning_autofix: *313 + graphql: *310 + search: *310 + code_search: *310 + source_import: *310 + integration_manifest: *310 + code_scanning_upload: *310 + actions_runner_registration: *310 + scim: *310 + dependency_snapshots: *310 + dependency_sbom: *310 + code_scanning_autofix: *310 required: - core - search - rate: *313 + rate: *310 required: - rate - resources @@ -50023,14 +49565,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '200': description: Response content: application/json: - schema: *314 + schema: *311 examples: default-response: summary: Default response @@ -50531,7 +50073,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *315 + '301': *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50549,8 +50091,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *311 - - *312 + - *308 + - *309 requestBody: required: false content: @@ -50798,10 +50340,10 @@ paths: description: Response content: application/json: - schema: *314 + schema: *311 examples: - default: *316 - '307': &317 + default: *313 + '307': &314 description: Temporary Redirect content: application/json: @@ -50830,8 +50372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '204': description: Response @@ -50853,7 +50395,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *317 + '307': *314 '404': *6 '409': *50 x-github: @@ -50877,11 +50419,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 - *17 - *19 - - &350 + - &347 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50904,7 +50446,7 @@ paths: type: integer artifacts: type: array - items: &318 + items: &315 title: Artifact description: An artifact type: object @@ -50999,7 +50541,7 @@ paths: - expires_at - updated_at examples: - default: &351 + default: &348 value: total_count: 2 artifacts: @@ -51060,9 +50602,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *311 - - *312 - - &319 + - *308 + - *309 + - &316 name: artifact_id description: The unique identifier of the artifact. in: path @@ -51074,7 +50616,7 @@ paths: description: Response content: application/json: - schema: *318 + schema: *315 examples: default: value: @@ -51112,9 +50654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *311 - - *312 - - *319 + - *308 + - *309 + - *316 responses: '204': description: Response @@ -51138,9 +50680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *311 - - *312 - - *319 + - *308 + - *309 + - *316 - name: archive_format in: path required: true @@ -51154,7 +50696,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': &506 + '410': &503 description: Gone content: application/json: @@ -51179,14 +50721,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '200': description: Response content: application/json: - schema: &320 + schema: &317 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -51220,13 +50762,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 requestBody: required: true content: application/json: - schema: *320 + schema: *317 examples: selected_actions: *40 responses: @@ -51255,14 +50797,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '200': description: Response content: application/json: - schema: &321 + schema: &318 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -51296,13 +50838,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 requestBody: required: true content: application/json: - schema: *321 + schema: *318 examples: selected_actions: *42 responses: @@ -51333,14 +50875,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '200': description: Response content: application/json: - schema: *322 + schema: *319 examples: default: value: @@ -51366,11 +50908,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 - *17 - *19 - - &323 + - &320 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/Hi! This is an area for us to collaborate as a team
" + 1 ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "node_id": { "type": "string", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "MDQ6VXNlcjE=" ] }, - "created_at": { + "avatar_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://github.com/images/error/octocat_happy.gif" ] }, - "last_edited_at": { + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" + "https://github.com/octocat" ] }, - "node_id": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "https://api.github.com/users/octocat/followers" ] }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", + "following_url": { + "type": "string", "examples": [ - 42 + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", + "gists_url": { + "type": "string", "examples": [ - true + "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.", - "type": "boolean", + "starred_url": { + "type": "string", "examples": [ - true + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "team_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "https://api.github.com/users/octocat/subscriptions" ] }, - "title": { - "description": "The title of the discussion.", + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "How can we improve our workflow?" + "https://api.github.com/users/octocat/orgs" ] }, - "updated_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/users/octocat/repos" ] }, - "url": { + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "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", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", + "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" ] } @@ -230136,52 +230310,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 } ] } @@ -230202,19 +230348,126 @@ "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/rest/teams/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "type": "string", + "examples": [ + "member" + ] + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" } }, - "post": { - "summary": "Create a discussion", - "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.", + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], - "operationId": "teams/create-discussion-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#create-a-discussion" + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -230234,39 +230487,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" } } } @@ -230274,430 +230528,83 @@ } }, "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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { + "url": { "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "format": "uri" }, - "last_edited_at": { - "type": [ - "string", - "null" + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { + "default": "member", "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "member" ] }, - "url": { + "state": { + "description": "The state of the user's membership in the team.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/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" } } } } } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "discussions" + "subcategory": "members" } - } - }, - "/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.", + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], - "operationId": "teams/get-discussion-in-org", + "operationId": "teams/remove-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#remove-team-membership-for-a-user" }, "parameters": [ { @@ -230719,437 +230626,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": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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 - } - } - } - } - } - } + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden if team synchronization is set up" } }, "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.", + } + }, + "/orgs/{org}/teams/{team_slug}/repos": { + "get": { + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/update-discussion-in-org", + "operationId": "teams/list-repos-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/teams#list-team-repositories" }, "parameters": [ { @@ -231171,604 +230683,62 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 30 } - } - ], - "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" - } - } - } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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 + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - "body": "Hi! This is an area 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", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" ] }, - "failed_reason": { - "type": [ - "string", - "null" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" ] }, - "inviter": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -231936,337 +230906,659 @@ "url" ] }, - "team_count": { - "type": "integer" + "private": { + "type": "boolean" }, - "node_id": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "https://github.com/octocat/Hello-World" ] }, - "invitation_teams_url": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "invitation_source": { + "archive_url": { "type": "string", "examples": [ - "\"member\"" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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": "Hi! This is an area for us to collaborate as a team
" + 42 ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "node_id": { "type": "string", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "MDQ6VGVhbTE=" ] }, - "created_at": { + "url": { + "description": "URL for the team", "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1" ] }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" + "https://github.com/orgs/rails/teams/core" ] }, - "node_id": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "Developers" ] }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", + "slug": { + "type": "string", "examples": [ - 42 + "justice-league" ] }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - true + "A great team." ] }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], "examples": [ - true + "closed" ] }, - "team_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "notifications_enabled" ] }, - "title": { - "description": "The title of the discussion.", + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "How can we improve our workflow?" + "push" ] }, - "updated_at": { + "members_url": { "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "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": { + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -624035,472 +619371,751 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -624508,361 +620123,763 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -624871,20 +620888,20 @@ "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true }, "delete": { - "summary": "Delete a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Delete a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], - "operationId": "teams/delete-discussion-legacy", + "operationId": "teams/delete-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy" + "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy" }, "parameters": [ { @@ -624895,20 +620912,112 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -624917,7 +621026,7 @@ "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index c5ea72e87..f136965b0 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1071,7 +1071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &618 + - &615 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -9170,7 +9170,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 - - &457 + - &454 name: has in: query description: |- @@ -9290,7 +9290,7 @@ paths: - direct - transitive - - security_advisory: &458 + security_advisory: &455 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9558,7 +9558,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &459 + auto_dismissed_at: &456 type: - string - 'null' @@ -9566,7 +9566,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &460 + dismissal_request: &457 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -10957,7 +10957,7 @@ paths: properties: action: type: string - discussion: &711 + discussion: &706 title: Discussion description: A Discussion in a repository. type: object @@ -11743,7 +11743,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &630 + sub_issues_summary: &627 title: Sub-issues Summary type: object properties: @@ -11764,7 +11764,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &631 + issue_dependencies_summary: &628 title: Issue Dependencies Summary type: object properties: @@ -11783,7 +11783,7 @@ paths: - total_blocking issue_field_values: type: array - items: &632 + items: &629 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11896,7 +11896,7 @@ paths: action: type: string issue: *71 - comment: &507 + comment: &504 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -12619,7 +12619,7 @@ paths: type: string release: allOf: - - &563 + - &560 title: Release description: A release. type: object @@ -12701,7 +12701,7 @@ paths: author: *4 assets: type: array - items: &564 + items: &561 title: Release Asset description: Data related to a release. type: object @@ -13304,7 +13304,7 @@ paths: url: type: string format: uri - user: &640 + user: &635 title: Public User description: Public User type: object @@ -16661,14 +16661,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &311 + - &308 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &312 + - &309 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -16730,7 +16730,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &315 + '301': &312 description: Moved permanently content: application/json: @@ -16752,7 +16752,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &537 + - &534 name: all description: If `true`, show notifications marked as read. in: query @@ -16760,7 +16760,7 @@ paths: schema: type: boolean default: false - - &538 + - &535 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -16770,7 +16770,7 @@ paths: type: boolean default: false - *77 - - &539 + - &536 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: @@ -17306,7 +17306,7 @@ paths: - url - subscription_url examples: - default: &540 + default: &537 value: - id: '1' repository: @@ -18333,7 +18333,7 @@ paths: - property_name - value examples: - default: &546 + default: &543 value: - property_name: environment value: production @@ -18383,7 +18383,7 @@ paths: required: - properties examples: - default: &547 + default: &544 value: properties: - property_name: environment @@ -18957,7 +18957,7 @@ paths: required: false schema: type: string - - &688 + - &683 name: model description: The model name to query usage for. The name is not case sensitive. in: query @@ -19103,7 +19103,7 @@ paths: parameters: - *66 - *108 - - &689 + - &684 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 @@ -19215,7 +19215,7 @@ paths: - *108 - *110 - *109 - - &690 + - &685 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -19223,7 +19223,7 @@ paths: schema: type: string - *111 - - &691 + - &686 name: sku description: The SKU to query for usage. in: query @@ -20202,7 +20202,7 @@ paths: type: integer repository_cache_usages: type: array - items: &322 + items: &319 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21440,7 +21440,7 @@ paths: - all - local_only - selected - selected_actions_url: &328 + selected_actions_url: &325 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` @@ -21523,7 +21523,7 @@ paths: description: Response content: application/json: - schema: &332 + schema: &329 type: object properties: days: @@ -21565,7 +21565,7 @@ paths: required: true content: application/json: - schema: &333 + schema: &330 type: object properties: days: @@ -21622,7 +21622,7 @@ paths: required: - approval_policy examples: - default: &334 + default: &331 value: approval_policy: first_time_contributors '404': *6 @@ -21681,7 +21681,7 @@ paths: description: Response content: application/json: - schema: &335 + schema: &332 type: object required: - run_workflows_from_fork_pull_requests @@ -21735,7 +21735,7 @@ paths: required: true content: application/json: - schema: &336 + schema: &333 type: object required: - run_workflows_from_fork_pull_requests @@ -22370,7 +22370,7 @@ paths: description: Response content: application/json: - schema: &337 + schema: &334 type: object properties: default_workflow_permissions: &138 @@ -22421,7 +22421,7 @@ paths: required: false content: application/json: - schema: &338 + schema: &335 type: object properties: default_workflow_permissions: *138 @@ -22914,7 +22914,7 @@ paths: type: array items: *145 examples: - default: &643 + default: &638 value: total_count: 1 repositories: @@ -23561,7 +23561,7 @@ paths: application/json: schema: type: array - items: &339 + items: &336 title: Runner Application description: Runner Application type: object @@ -23586,7 +23586,7 @@ paths: - download_url - filename examples: - default: &340 + default: &337 value: - os: osx architecture: x64 @@ -23672,7 +23672,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &341 + '201': &338 description: Response content: application/json: @@ -23787,7 +23787,7 @@ paths: - token - expires_at examples: - default: &342 + default: &339 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -23826,7 +23826,7 @@ paths: application/json: schema: *149 examples: - default: &343 + default: &340 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -23860,7 +23860,7 @@ paths: application/json: schema: *147 examples: - default: &344 + default: &341 value: id: 23 name: MBP @@ -24086,7 +24086,7 @@ paths: - *66 - *146 responses: - '200': &345 + '200': &342 description: Response content: application/json: @@ -24143,7 +24143,7 @@ paths: parameters: - *66 - *146 - - &346 + - &343 name: name description: The name of a self-hosted runner's custom label. in: path @@ -24275,7 +24275,7 @@ paths: description: Response content: application/json: - schema: &358 + schema: &355 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -24310,7 +24310,7 @@ paths: - key_id - key examples: - default: &359 + default: &356 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24723,7 +24723,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *66 - - &327 + - &324 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)." @@ -25885,12 +25885,12 @@ paths: required: - subject_digests examples: - default: &670 + default: &665 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &671 + withPredicateType: &666 value: subject_digests: - sha256:abc123 @@ -25949,7 +25949,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &672 + default: &667 value: attestations_subject_digests: - sha256:abc: @@ -26298,7 +26298,7 @@ paths: initiator: type: string examples: - default: &372 + default: &369 value: attestations: - bundle: @@ -27254,7 +27254,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *66 - - &396 + - &393 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`, @@ -27264,7 +27264,7 @@ paths: schema: &170 type: string description: The name of the tool used to generate the code scanning analysis. - - &397 + - &394 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 @@ -27288,7 +27288,7 @@ paths: be returned. in: query required: false - schema: &399 + schema: &396 type: string description: State of a code scanning alert. enum: @@ -27311,7 +27311,7 @@ paths: be returned. in: query required: false - schema: &400 + schema: &397 type: string description: Severity of a code scanning alert. enum: @@ -27345,7 +27345,7 @@ paths: updated_at: *165 url: *166 html_url: *167 - instances_url: &401 + instances_url: &398 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -27367,7 +27367,7 @@ paths: - type: 'null' - *4 dismissed_at: *169 - dismissed_reason: &402 + dismissed_reason: &399 type: - string - 'null' @@ -27378,14 +27378,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &403 + dismissed_comment: &400 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &404 + rule: &401 type: object properties: id: @@ -27446,7 +27446,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &405 + tool: &402 type: object properties: name: *170 @@ -27457,26 +27457,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *171 - most_recent_instance: &406 + most_recent_instance: &403 type: object properties: - ref: &398 + ref: &395 type: string description: |- The Git reference, formatted as `refs/pull/Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, - this update operation will be rejected if the given version - does not match the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned - for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted - to team members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *73 - 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: &634 - value: - - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: *57 - 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: - - *66 - - *67 - 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: *307 - examples: - default: &308 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *66 - - *67 - - &309 - 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: *307 - examples: - default: *308 - 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: - - *66 - - *67 - - *309 - 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: *307 - examples: - default: &635 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *66 - - *67 - - *309 - 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 @@ -48797,7 +48339,7 @@ paths: description: Response content: application/json: - schema: &310 + schema: &307 title: Team Membership description: Team Membership type: object @@ -48825,7 +48367,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &636 + response-if-user-is-a-team-maintainer: &631 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -48888,9 +48430,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *307 examples: - response-if-users-membership-with-team-is-now-pending: &637 + response-if-users-membership-with-team-is-now-pending: &632 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -48997,14 +48539,14 @@ paths: parameters: - *66 - *67 - - *311 - - *312 + - *308 + - *309 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &638 + schema: &633 title: Team Repository description: A team's access to a repository. type: object @@ -49647,8 +49189,8 @@ paths: parameters: - *66 - *67 - - *311 - - *312 + - *308 + - *309 requestBody: required: false content: @@ -49695,8 +49237,8 @@ paths: parameters: - *66 - *67 - - *311 - - *312 + - *308 + - *309 responses: '204': description: Response @@ -49733,7 +49275,7 @@ paths: type: array items: *180 examples: - response-if-child-teams-exist: &639 + response-if-child-teams-exist: &634 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -49887,7 +49429,7 @@ paths: resources: type: object properties: - core: &313 + core: &310 title: Rate Limit type: object properties: @@ -49904,21 +49446,21 @@ paths: - remaining - reset - used - graphql: *313 - search: *313 - code_search: *313 - source_import: *313 - integration_manifest: *313 - code_scanning_upload: *313 - actions_runner_registration: *313 - scim: *313 - dependency_snapshots: *313 - dependency_sbom: *313 - code_scanning_autofix: *313 + graphql: *310 + search: *310 + code_search: *310 + source_import: *310 + integration_manifest: *310 + code_scanning_upload: *310 + actions_runner_registration: *310 + scim: *310 + dependency_snapshots: *310 + dependency_sbom: *310 + code_scanning_autofix: *310 required: - core - search - rate: *313 + rate: *310 required: - rate - resources @@ -50023,14 +49565,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '200': description: Response content: application/json: - schema: *314 + schema: *311 examples: default-response: summary: Default response @@ -50531,7 +50073,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *315 + '301': *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50549,8 +50091,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *311 - - *312 + - *308 + - *309 requestBody: required: false content: @@ -50798,10 +50340,10 @@ paths: description: Response content: application/json: - schema: *314 + schema: *311 examples: - default: *316 - '307': &317 + default: *313 + '307': &314 description: Temporary Redirect content: application/json: @@ -50830,8 +50372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '204': description: Response @@ -50853,7 +50395,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *317 + '307': *314 '404': *6 '409': *50 x-github: @@ -50877,11 +50419,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 - *17 - *19 - - &350 + - &347 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50904,7 +50446,7 @@ paths: type: integer artifacts: type: array - items: &318 + items: &315 title: Artifact description: An artifact type: object @@ -50999,7 +50541,7 @@ paths: - expires_at - updated_at examples: - default: &351 + default: &348 value: total_count: 2 artifacts: @@ -51060,9 +50602,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *311 - - *312 - - &319 + - *308 + - *309 + - &316 name: artifact_id description: The unique identifier of the artifact. in: path @@ -51074,7 +50616,7 @@ paths: description: Response content: application/json: - schema: *318 + schema: *315 examples: default: value: @@ -51112,9 +50654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *311 - - *312 - - *319 + - *308 + - *309 + - *316 responses: '204': description: Response @@ -51138,9 +50680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *311 - - *312 - - *319 + - *308 + - *309 + - *316 - name: archive_format in: path required: true @@ -51154,7 +50696,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': &506 + '410': &503 description: Gone content: application/json: @@ -51179,14 +50721,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '200': description: Response content: application/json: - schema: &320 + schema: &317 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -51220,13 +50762,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 requestBody: required: true content: application/json: - schema: *320 + schema: *317 examples: selected_actions: *40 responses: @@ -51255,14 +50797,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '200': description: Response content: application/json: - schema: &321 + schema: &318 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -51296,13 +50838,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 requestBody: required: true content: application/json: - schema: *321 + schema: *318 examples: selected_actions: *42 responses: @@ -51333,14 +50875,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 responses: '200': description: Response content: application/json: - schema: *322 + schema: *319 examples: default: value: @@ -51366,11 +50908,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *311 - - *312 + - *308 + - *309 - *17 - *19 - - &323 + - &320 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], "properties": { - "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" + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] }, - "eyes": { - "type": "integer" + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] }, - "rocket": { - "type": "integer" + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" }, - "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" - ] + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } } }, "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 + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" }, - "body": "Hi! This is an area 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 + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" } - } - ] + ] + } } } } - }, - "headers": { - "Link": { - "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.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", + "group_id": { + "description": "The internal ID of the group", "type": "integer", "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" + 1 ] }, - "title": { - "description": "The title of the discussion.", + "group_name": { + "description": "The display name for the group", "type": "string", "examples": [ - "How can we improve our workflow?" + "group-azuread-test" ] }, "updated_at": { + "description": "The date when the group was last updated_at", "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "2021-01-03 22:27:15:000 -700" ] }, - "url": { - "type": "string", - "format": "uri", + "teams": { + "description": "An array of teams linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "type": "integer", + "examples": [ + 1 + ] + }, + "team_name": { + "description": "The name of the team", + "type": "string", + "examples": [ + "team-test" + ] + } + } + }, "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } ] }, - "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" + "members": { + "description": "An array of external members linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "type": "integer", + "examples": [ + 1 + ] + }, + "member_login": { + "description": "The handle/login for the user", + "type": "string", + "examples": [ + "mona-lisa_eocsaxrs" + ] + }, + "member_name": { + "description": "The user display name/profile name", + "type": "string", + "examples": [ + "Mona Lisa" + ] + }, + "member_email": { + "description": "An email attached to a user", + "type": "string", + "examples": [ + "mona_lisa@github.com" + ] + } } }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "examples": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } ] } - }, - "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 - } + "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" + } + ] } } } @@ -286169,25 +285548,67 @@ } }, "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "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": "discussions" + "subcategory": "external-groups" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + "/orgs/{org}/teams/{team_slug}/invitations": { "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": "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/get-discussion-in-org", + "operationId": "teams/list-pending-invitations-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" }, "parameters": [ { @@ -286209,12 +285630,21 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 30 + } + }, + { + "name": "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 } } ], @@ -286224,353 +285654,553 @@ "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "eyes": { - "type": "integer" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false }, - "rocket": { - "type": "integer" - } + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "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": "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { + "url": { "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "format": "uri" }, - "last_edited_at": { - "type": [ - "string", - "null" + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { + "default": "member", "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "member" ] }, - "url": { + "state": { + "description": "The state of the user's membership in the team.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/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": "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 - } + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" } } } } } - } - }, - "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": [ - { - "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" - } - } - ], - "responses": { - "204": { - "description": "Response" + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "discussions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/external-groups": { - "get": { - "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name of the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The time of the last update for this group", - "type": "string", - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "external-groups" + "subcategory": "members" } }, - "patch": { - "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], - "operationId": "teams/link-external-idp-group-to-team-for-org", + "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -287311,238 +286515,10 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group_id": { - "type": "integer", - "description": "External Group Id", - "examples": [ - 1 - ] - } - }, - "required": [ - "group_id" - ] - }, - "examples": { - "default": { - "value": { - "group_id": 123 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", - "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name for the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "type": "string", - "examples": [ - "2021-01-03 22:27:15:000 -700" - ] - }, - "teams": { - "description": "An array of teams linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "team_id", - "team_name" - ], - "properties": { - "team_id": { - "description": "The id for a team", - "type": "integer", - "examples": [ - 1 - ] - }, - "team_name": { - "description": "The name of the team", - "type": "string", - "examples": [ - "team-test" - ] - } - } - }, - "examples": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ] - }, - "members": { - "description": "An array of external members linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "type": "integer", - "examples": [ - 1 - ] - }, - "member_login": { - "description": "The handle/login for the user", - "type": "string", - "examples": [ - "mona-lisa_eocsaxrs" - ] - }, - "member_name": { - "description": "The user display name/profile name", - "type": "string", - "examples": [ - "Mona Lisa" - ] - }, - "member_email": { - "description": "An email attached to a user", - "type": "string", - "examples": [ - "mona_lisa@github.com" - ] - } - } - }, - "examples": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00", - "teams": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ], - "members": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "external-groups" - } - }, - "delete": { - "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/unlink-external-idp-group-from-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -287553,27 +286529,30 @@ "responses": { "204": { "description": "Response" + }, + "403": { + "description": "Forbidden if team synchronization is set up" } }, "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "teams", - "subcategory": "external-groups" + "subcategory": "members" } } }, - "/orgs/{org}/teams/{team_slug}/invitations": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List pending team invitations", - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-pending-invitations-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -287621,45 +286600,36 @@ "schema": { "type": "array", "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64" - }, - "login": { - "type": [ - "string", - "null" + "format": "int64", + "examples": [ + 1296269 ] }, - "email": { - "type": [ - "string", - "null" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" ] }, - "failed_reason": { - "type": [ - "string", - "null" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" ] }, - "inviter": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -287827,1053 +286797,118 @@ "url" ] }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] + "private": { + "type": "boolean" }, - "invitation_teams_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "https://github.com/octocat/Hello-World" ] }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" - ] - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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": "Hi! This is an area for us to collaborate as a team
" + 42 ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "node_id": { "type": "string", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "MDQ6VGVhbTE=" ] }, - "created_at": { + "url": { + "description": "URL for the team", "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1" ] }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" + "https://github.com/orgs/rails/teams/core" ] }, - "node_id": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "Developers" ] }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", + "slug": { + "type": "string", "examples": [ - 42 + "justice-league" ] }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - true + "A great team." ] }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], "examples": [ - true + "closed" ] }, - "team_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "notifications_enabled" ] }, - "title": { - "description": "The title of the discussion.", + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "How can we improve our workflow?" + "push" ] }, - "updated_at": { + "members_url": { "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "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-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/get-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -698393,472 +693729,751 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -698866,361 +694481,763 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -699229,20 +695246,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": [ { @@ -699253,20 +695270,112 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -699275,7 +695384,7 @@ "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true } diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 493f491ac..9fd75a573 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -1079,7 +1079,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &729 + - &726 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1808,7 +1808,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &739 + schema: &736 title: Scim Error description: Scim Error type: object @@ -9260,7 +9260,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &740 + '401': &737 description: Authorization failure '404': *6 x-github: @@ -13533,7 +13533,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &514 + instances_url: &511 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13569,7 +13569,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &515 + dismissed_reason: &512 type: - string - 'null' @@ -13580,14 +13580,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &516 + dismissed_comment: &513 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &517 + rule: &514 type: object properties: id: @@ -13648,7 +13648,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &518 + tool: &515 type: object properties: name: *109 @@ -13659,26 +13659,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *110 - most_recent_instance: &519 + most_recent_instance: &516 type: object properties: - ref: &512 + ref: &509 type: string description: |- The Git reference, formatted as `refs/pull/Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, - this update operation will be rejected if the given version - does not match the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned - for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted - to team members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *215 - 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: &771 - value: - - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: *45 - 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: - - *85 - - *210 - 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: *433 - examples: - default: &434 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *85 - - *210 - - &435 - 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: *433 - examples: - default: *434 - 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: - - *85 - - *210 - - *435 - 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: *433 - examples: - default: &772 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *85 - - *210 - - *435 - 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 @@ -60850,9 +60392,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *433 examples: - default: *437 + default: *434 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -60896,9 +60438,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *435 examples: - default: *439 + default: *436 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -61039,7 +60581,7 @@ paths: description: Response content: application/json: - schema: &440 + schema: &437 title: Team Membership description: Team Membership type: object @@ -61067,7 +60609,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &773 + response-if-user-is-a-team-maintainer: &768 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -61130,9 +60672,9 @@ paths: description: Response content: application/json: - schema: *440 + schema: *437 examples: - response-if-users-membership-with-team-is-now-pending: &774 + response-if-users-membership-with-team-is-now-pending: &769 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -61239,14 +60781,14 @@ paths: parameters: - *85 - *210 - - *441 - - *442 + - *438 + - *439 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &775 + schema: &770 title: Team Repository description: A team's access to a repository. type: object @@ -61889,8 +61431,8 @@ paths: parameters: - *85 - *210 - - *441 - - *442 + - *438 + - *439 requestBody: required: false content: @@ -61937,8 +61479,8 @@ paths: parameters: - *85 - *210 - - *441 - - *442 + - *438 + - *439 responses: '204': description: Response @@ -61971,9 +61513,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *440 examples: - default: *444 + default: *441 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -62039,7 +61581,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *440 examples: default: value: @@ -62084,7 +61626,7 @@ paths: type: array items: *302 examples: - response-if-child-teams-exist: &776 + response-if-child-teams-exist: &771 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -62238,7 +61780,7 @@ paths: resources: type: object properties: - core: &445 + core: &442 title: Rate Limit type: object properties: @@ -62255,21 +61797,21 @@ paths: - remaining - reset - used - graphql: *445 - search: *445 - code_search: *445 - source_import: *445 - integration_manifest: *445 - code_scanning_upload: *445 - actions_runner_registration: *445 - scim: *445 - dependency_snapshots: *445 - dependency_sbom: *445 - code_scanning_autofix: *445 + graphql: *442 + search: *442 + code_search: *442 + source_import: *442 + integration_manifest: *442 + code_scanning_upload: *442 + actions_runner_registration: *442 + scim: *442 + dependency_snapshots: *442 + dependency_sbom: *442 + code_scanning_autofix: *442 required: - core - search - rate: *445 + rate: *442 required: - rate - resources @@ -62374,14 +61916,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *441 - - *442 + - *438 + - *439 responses: '200': description: Response content: application/json: - schema: *446 + schema: *443 examples: default-response: summary: Default response @@ -62886,7 +62428,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *447 + '301': *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62904,8 +62446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *441 - - *442 + - *438 + - *439 requestBody: required: false content: @@ -63163,10 +62705,10 @@ paths: description: Response content: application/json: - schema: *446 + schema: *443 examples: - default: *448 - '307': &449 + default: *445 + '307': &446 description: Temporary Redirect content: application/json: @@ -63195,8 +62737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *441 - - *442 + - *438 + - *439 responses: '204': description: Response @@ -63218,7 +62760,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': *449 + '307': *446 '404': *6 '409': *117 x-github: @@ -63242,11 +62784,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *441 - - *442 + - *438 + - *439 - *17 - *19 - - &466 + - &463 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -63269,7 +62811,7 @@ paths: type: integer artifacts: type: array - items: &450 + items: &447 title: Artifact description: An artifact type: object @@ -63364,7 +62906,7 @@ paths: - expires_at - updated_at examples: - default: &467 + default: &464 value: total_count: 2 artifacts: @@ -63425,9 +62967,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *441 - - *442 - - &451 + - *438 + - *439 + - &448 name: artifact_id description: The unique identifier of the artifact. in: path @@ -63439,7 +62981,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *447 examples: default: value: @@ -63477,9 +63019,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *441 - - *442 - - *451 + - *438 + - *439 + - *448 responses: '204': description: Response @@ -63503,9 +63045,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *441 - - *442 - - *451 + - *438 + - *439 + - *448 - name: archive_format in: path required: true @@ -63519,7 +63061,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': &629 + '410': &626 description: Gone content: application/json: @@ -63544,14 +63086,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: - - *441 - - *442 + - *438 + - *439 responses: '200': description: Response content: application/json: - schema: &452 + schema: &449 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -63585,13 +63127,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: - - *441 - - *442 + - *438 + - *439 requestBody: required: true content: application/json: - schema: *452 + schema: *449 examples: selected_actions: *42 responses: @@ -63620,14 +63162,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: - - *441 - - *442 + - *438 + - *439 responses: '200': description: Response content: application/json: - schema: &453 + schema: &450 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -63661,13 +63203,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: - - *441 - - *442 + - *438 + - *439 requestBody: required: true content: application/json: - schema: *453 + schema: *450 examples: selected_actions: *44 responses: @@ -63698,14 +63240,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: - - *441 - - *442 + - *438 + - *439 responses: '200': description: Response content: application/json: - schema: *454 + schema: *451 examples: default: value: @@ -63731,11 +63273,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: - - *441 - - *442 + - *438 + - *439 - *17 - *19 - - &455 + - &452 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], "properties": { - "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" + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] }, - "eyes": { - "type": "integer" + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] }, - "rocket": { - "type": "integer" + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" }, - "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" - ] + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } } }, "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 + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" }, - "body": "Hi! This is an area 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 + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" } - } - ] + ] + } } } } - }, - "headers": { - "Link": { - "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.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", + "group_id": { + "description": "The internal ID of the group", "type": "integer", "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" + 1 ] }, - "title": { - "description": "The title of the discussion.", + "group_name": { + "description": "The display name for the group", "type": "string", "examples": [ - "How can we improve our workflow?" + "group-azuread-test" ] }, "updated_at": { + "description": "The date when the group was last updated_at", "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "2021-01-03 22:27:15:000 -700" ] }, - "url": { - "type": "string", - "format": "uri", + "teams": { + "description": "An array of teams linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "type": "integer", + "examples": [ + 1 + ] + }, + "team_name": { + "description": "The name of the team", + "type": "string", + "examples": [ + "team-test" + ] + } + } + }, "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } ] }, - "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" + "members": { + "description": "An array of external members linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "type": "integer", + "examples": [ + 1 + ] + }, + "member_login": { + "description": "The handle/login for the user", + "type": "string", + "examples": [ + "mona-lisa_eocsaxrs" + ] + }, + "member_name": { + "description": "The user display name/profile name", + "type": "string", + "examples": [ + "Mona Lisa" + ] + }, + "member_email": { + "description": "An email attached to a user", + "type": "string", + "examples": [ + "mona_lisa@github.com" + ] + } } }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "examples": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } ] } - }, - "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 - } + "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" + } + ] } } } @@ -286169,25 +285548,67 @@ } }, "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "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": "discussions" + "subcategory": "external-groups" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + "/orgs/{org}/teams/{team_slug}/invitations": { "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": "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/get-discussion-in-org", + "operationId": "teams/list-pending-invitations-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" }, "parameters": [ { @@ -286209,12 +285630,21 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 30 + } + }, + { + "name": "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 } } ], @@ -286224,353 +285654,553 @@ "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "eyes": { - "type": "integer" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false }, - "rocket": { - "type": "integer" - } + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "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": "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { + "url": { "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "format": "uri" }, - "last_edited_at": { - "type": [ - "string", - "null" + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { + "default": "member", "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "member" ] }, - "url": { + "state": { + "description": "The state of the user's membership in the team.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/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": "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 - } + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" } } } } } - } - }, - "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": [ - { - "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" - } - } - ], - "responses": { - "204": { - "description": "Response" + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "teams", - "subcategory": "discussions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/external-groups": { - "get": { - "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name of the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The time of the last update for this group", - "type": "string", - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "external-groups" + "subcategory": "members" } }, - "patch": { - "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], - "operationId": "teams/link-external-idp-group-to-team-for-org", + "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -287311,238 +286515,10 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group_id": { - "type": "integer", - "description": "External Group Id", - "examples": [ - 1 - ] - } - }, - "required": [ - "group_id" - ] - }, - "examples": { - "default": { - "value": { - "group_id": 123 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", - "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name for the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "type": "string", - "examples": [ - "2021-01-03 22:27:15:000 -700" - ] - }, - "teams": { - "description": "An array of teams linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "team_id", - "team_name" - ], - "properties": { - "team_id": { - "description": "The id for a team", - "type": "integer", - "examples": [ - 1 - ] - }, - "team_name": { - "description": "The name of the team", - "type": "string", - "examples": [ - "team-test" - ] - } - } - }, - "examples": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ] - }, - "members": { - "description": "An array of external members linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "type": "integer", - "examples": [ - 1 - ] - }, - "member_login": { - "description": "The handle/login for the user", - "type": "string", - "examples": [ - "mona-lisa_eocsaxrs" - ] - }, - "member_name": { - "description": "The user display name/profile name", - "type": "string", - "examples": [ - "Mona Lisa" - ] - }, - "member_email": { - "description": "An email attached to a user", - "type": "string", - "examples": [ - "mona_lisa@github.com" - ] - } - } - }, - "examples": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00", - "teams": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ], - "members": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "external-groups" - } - }, - "delete": { - "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/unlink-external-idp-group-from-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -287553,27 +286529,30 @@ "responses": { "204": { "description": "Response" + }, + "403": { + "description": "Forbidden if team synchronization is set up" } }, "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "teams", - "subcategory": "external-groups" + "subcategory": "members" } } }, - "/orgs/{org}/teams/{team_slug}/invitations": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List pending team invitations", - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-pending-invitations-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -287621,45 +286600,36 @@ "schema": { "type": "array", "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64" - }, - "login": { - "type": [ - "string", - "null" + "format": "int64", + "examples": [ + 1296269 ] }, - "email": { - "type": [ - "string", - "null" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" + "name": { + "type": "string", + "examples": [ + "Hello-World" ] }, - "failed_reason": { - "type": [ - "string", - "null" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" ] }, - "inviter": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -287827,1053 +286797,118 @@ "url" ] }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] + "private": { + "type": "boolean" }, - "invitation_teams_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "https://github.com/octocat/Hello-World" ] }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" - ] - } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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": "Hi! This is an area for us to collaborate as a team
" + 42 ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "node_id": { "type": "string", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "MDQ6VGVhbTE=" ] }, - "created_at": { + "url": { + "description": "URL for the team", "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1" ] }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" + "https://github.com/orgs/rails/teams/core" ] }, - "node_id": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "Developers" ] }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", + "slug": { + "type": "string", "examples": [ - 42 + "justice-league" ] }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - true + "A great team." ] }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], "examples": [ - true + "closed" ] }, - "team_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "notifications_enabled" ] }, - "title": { - "description": "The title of the discussion.", + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "How can we improve our workflow?" + "push" ] }, - "updated_at": { + "members_url": { "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "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-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/get-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -698393,472 +693729,751 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -698866,361 +694481,763 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -699229,20 +695246,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": [ { @@ -699253,20 +695270,112 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -699275,7 +695384,7 @@ "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true } diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 493f491ac..9fd75a573 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -1079,7 +1079,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &729 + - &726 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1808,7 +1808,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &739 + schema: &736 title: Scim Error description: Scim Error type: object @@ -9260,7 +9260,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &740 + '401': &737 description: Authorization failure '404': *6 x-github: @@ -13533,7 +13533,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &514 + instances_url: &511 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13569,7 +13569,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &515 + dismissed_reason: &512 type: - string - 'null' @@ -13580,14 +13580,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &516 + dismissed_comment: &513 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &517 + rule: &514 type: object properties: id: @@ -13648,7 +13648,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &518 + tool: &515 type: object properties: name: *109 @@ -13659,26 +13659,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *110 - most_recent_instance: &519 + most_recent_instance: &516 type: object properties: - ref: &512 + ref: &509 type: string description: |- The Git reference, formatted as `refs/pull/Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, - this update operation will be rejected if the given version - does not match the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned - for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted - to team members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *215 - 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: &771 - value: - - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: *45 - 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: - - *85 - - *210 - 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: *433 - examples: - default: &434 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *85 - - *210 - - &435 - 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: *433 - examples: - default: *434 - 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: - - *85 - - *210 - - *435 - 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: *433 - examples: - default: &772 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *85 - - *210 - - *435 - 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 @@ -60850,9 +60392,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *433 examples: - default: *437 + default: *434 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -60896,9 +60438,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *435 examples: - default: *439 + default: *436 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -61039,7 +60581,7 @@ paths: description: Response content: application/json: - schema: &440 + schema: &437 title: Team Membership description: Team Membership type: object @@ -61067,7 +60609,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &773 + response-if-user-is-a-team-maintainer: &768 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -61130,9 +60672,9 @@ paths: description: Response content: application/json: - schema: *440 + schema: *437 examples: - response-if-users-membership-with-team-is-now-pending: &774 + response-if-users-membership-with-team-is-now-pending: &769 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -61239,14 +60781,14 @@ paths: parameters: - *85 - *210 - - *441 - - *442 + - *438 + - *439 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &775 + schema: &770 title: Team Repository description: A team's access to a repository. type: object @@ -61889,8 +61431,8 @@ paths: parameters: - *85 - *210 - - *441 - - *442 + - *438 + - *439 requestBody: required: false content: @@ -61937,8 +61479,8 @@ paths: parameters: - *85 - *210 - - *441 - - *442 + - *438 + - *439 responses: '204': description: Response @@ -61971,9 +61513,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *440 examples: - default: *444 + default: *441 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -62039,7 +61581,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *440 examples: default: value: @@ -62084,7 +61626,7 @@ paths: type: array items: *302 examples: - response-if-child-teams-exist: &776 + response-if-child-teams-exist: &771 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -62238,7 +61780,7 @@ paths: resources: type: object properties: - core: &445 + core: &442 title: Rate Limit type: object properties: @@ -62255,21 +61797,21 @@ paths: - remaining - reset - used - graphql: *445 - search: *445 - code_search: *445 - source_import: *445 - integration_manifest: *445 - code_scanning_upload: *445 - actions_runner_registration: *445 - scim: *445 - dependency_snapshots: *445 - dependency_sbom: *445 - code_scanning_autofix: *445 + graphql: *442 + search: *442 + code_search: *442 + source_import: *442 + integration_manifest: *442 + code_scanning_upload: *442 + actions_runner_registration: *442 + scim: *442 + dependency_snapshots: *442 + dependency_sbom: *442 + code_scanning_autofix: *442 required: - core - search - rate: *445 + rate: *442 required: - rate - resources @@ -62374,14 +61916,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *441 - - *442 + - *438 + - *439 responses: '200': description: Response content: application/json: - schema: *446 + schema: *443 examples: default-response: summary: Default response @@ -62886,7 +62428,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *447 + '301': *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62904,8 +62446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *441 - - *442 + - *438 + - *439 requestBody: required: false content: @@ -63163,10 +62705,10 @@ paths: description: Response content: application/json: - schema: *446 + schema: *443 examples: - default: *448 - '307': &449 + default: *445 + '307': &446 description: Temporary Redirect content: application/json: @@ -63195,8 +62737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *441 - - *442 + - *438 + - *439 responses: '204': description: Response @@ -63218,7 +62760,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': *449 + '307': *446 '404': *6 '409': *117 x-github: @@ -63242,11 +62784,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *441 - - *442 + - *438 + - *439 - *17 - *19 - - &466 + - &463 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -63269,7 +62811,7 @@ paths: type: integer artifacts: type: array - items: &450 + items: &447 title: Artifact description: An artifact type: object @@ -63364,7 +62906,7 @@ paths: - expires_at - updated_at examples: - default: &467 + default: &464 value: total_count: 2 artifacts: @@ -63425,9 +62967,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *441 - - *442 - - &451 + - *438 + - *439 + - &448 name: artifact_id description: The unique identifier of the artifact. in: path @@ -63439,7 +62981,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *447 examples: default: value: @@ -63477,9 +63019,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *441 - - *442 - - *451 + - *438 + - *439 + - *448 responses: '204': description: Response @@ -63503,9 +63045,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *441 - - *442 - - *451 + - *438 + - *439 + - *448 - name: archive_format in: path required: true @@ -63519,7 +63061,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': &629 + '410': &626 description: Gone content: application/json: @@ -63544,14 +63086,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: - - *441 - - *442 + - *438 + - *439 responses: '200': description: Response content: application/json: - schema: &452 + schema: &449 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -63585,13 +63127,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: - - *441 - - *442 + - *438 + - *439 requestBody: required: true content: application/json: - schema: *452 + schema: *449 examples: selected_actions: *42 responses: @@ -63620,14 +63162,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: - - *441 - - *442 + - *438 + - *439 responses: '200': description: Response content: application/json: - schema: &453 + schema: &450 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -63661,13 +63203,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: - - *441 - - *442 + - *438 + - *439 requestBody: required: true content: application/json: - schema: *453 + schema: *450 examples: selected_actions: *44 responses: @@ -63698,14 +63240,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: - - *441 - - *442 + - *438 + - *439 responses: '200': description: Response content: application/json: - schema: *454 + schema: *451 examples: default: value: @@ -63731,11 +63273,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: - - *441 - - *442 + - *438 + - *439 - *17 - *19 - - &455 + - &452 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "$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", @@ -323195,158 +322457,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": { @@ -345259,15 +344369,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-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 8cb8b27c5..be90fab4d 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -29441,231 +29441,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 @@ -58110,235 +57885,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) @@ -103638,105 +103184,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: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - body: - description: The main text of the discussion. - type: string - examples: - - Please suggest improvements to our workflow in comments. - body_html: - type: string - examples: - - "Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted to team - members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: - "$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 @@ -238485,144 +237932,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: @@ -257492,13 +256801,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-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index bd9c40489..35b69b5df 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -40853,313 +40853,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", @@ -80397,304 +80090,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)", @@ -143066,139 +142461,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": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "$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", @@ -323195,158 +322457,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": { @@ -345259,15 +344369,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-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 8cb8b27c5..be90fab4d 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -29441,231 +29441,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 @@ -58110,235 +57885,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) @@ -103638,105 +103184,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: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - body: - description: The main text of the discussion. - type: string - examples: - - Please suggest improvements to our workflow in comments. - body_html: - type: string - examples: - - "Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted to team - members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: - "$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 @@ -238485,144 +237932,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: @@ -257492,13 +256801,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-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index 9ffbc69e8..bfb163520 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -215429,17 +215429,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": [ { @@ -215459,19 +215459,421 @@ "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ExternalGroups", + "description": "A list of external groups available to be connected to a team", + "type": "object", + "properties": { + "groups": { + "description": "An array of external groups available to be mapped to a team", + "type": "array", + "items": { + "type": "object", + "required": [ + "group_id", + "group_name", + "updated_at" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name of the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The time of the last update for this group", + "type": "string", + "examples": [ + "2019-06-03 22:27:15:000 -700" + ] + } + } + }, + "examples": [ + { + "group_id": 1, + "group_name": "group-azuread-test", + "updated_at": "2021-01-03 22:27:15:000 -700" + }, + { + "group_id": 2, + "group_name": "group-azuread-test2", + "updated_at": "2021-06-03 22:27:15:000 -700" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00" + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "updated_at": "2021-03-24T11:31:04-06:00" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "external-groups" + } + }, + "patch": { + "summary": "Update the connection between an external group and a team", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/link-external-idp-group-to-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "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", + "examples": [ + 1 + ] + } + }, + "required": [ + "group_id" + ] + }, + "examples": { + "default": { + "value": { + "group_id": 123 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ExternalGroup", + "description": "Information about an external group's usage and its members", + "type": "object", + "required": [ + "group_id", + "group_name", + "teams", + "members" + ], + "properties": { + "group_id": { + "description": "The internal ID of the group", + "type": "integer", + "examples": [ + 1 + ] + }, + "group_name": { + "description": "The display name for the group", + "type": "string", + "examples": [ + "group-azuread-test" + ] + }, + "updated_at": { + "description": "The date when the group was last updated_at", + "type": "string", + "examples": [ + "2021-01-03 22:27:15:000 -700" + ] + }, + "teams": { + "description": "An array of teams linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "team_id", + "team_name" + ], + "properties": { + "team_id": { + "description": "The id for a team", + "type": "integer", + "examples": [ + 1 + ] + }, + "team_name": { + "description": "The name of the team", + "type": "string", + "examples": [ + "team-test" + ] + } + } + }, + "examples": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ] + }, + "members": { + "description": "An array of external members linked to this group", + "type": "array", + "items": { + "type": "object", + "required": [ + "member_id", + "member_login", + "member_name", + "member_email" + ], + "properties": { + "member_id": { + "description": "The internal user ID of the identity", + "type": "integer", + "examples": [ + 1 + ] + }, + "member_login": { + "description": "The handle/login for the user", + "type": "string", + "examples": [ + "mona-lisa_eocsaxrs" + ] + }, + "member_name": { + "description": "The user display name/profile name", + "type": "string", + "examples": [ + "Mona Lisa" + ] + }, + "member_email": { + "description": "An email attached to a user", + "type": "string", + "examples": [ + "mona_lisa@github.com" + ] + } + } + }, + "examples": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "group_id": "123", + "group_name": "Octocat admins", + "updated_at": "2021-01-24T11:31:04-06:00", + "teams": [ + { + "team_id": 1, + "team_name": "team-test" + }, + { + "team_id": 2, + "team_name": "team-test2" + } + ], + "members": [ + { + "member_id": 1, + "member_login": "mona-lisa_eocsaxrs", + "member_name": "Mona Lisa", + "member_email": "mona_lisa@github.com" + }, + { + "member_id": 2, + "member_login": "octo-lisa_eocsaxrs", + "member_name": "Octo Lisa", + "member_email": "octo_lisa@github.com" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "external-groups" + } + }, + "delete": { + "summary": "Remove the connection between an external group and a team", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "teams" + ], + "operationId": "teams/unlink-external-idp-group-from-team-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "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" } }, { @@ -215491,15 +215893,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "pinned", - "in": "query", - "required": false, - "description": "Pinned discussions only filter", - "schema": { - "type": "string" - } } ], "responses": { @@ -215510,346 +215903,170 @@ "schema": { "type": "array", "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "name": { + "type": [ + "string", + "null" ] }, - "body": { - "description": "The main text of the discussion.", + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "Please suggest improvements to our workflow in comments." + "octocat" ] }, - "body_html": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 1 ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "node_id": { "type": "string", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "MDQ6VXNlcjE=" ] }, - "created_at": { + "avatar_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://github.com/images/error/octocat_happy.gif" ] }, - "last_edited_at": { + "gravatar_id": { "type": [ "string", "null" ], - "format": "date-time" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" + "https://github.com/octocat" ] }, - "node_id": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "https://api.github.com/users/octocat/followers" ] }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", + "following_url": { + "type": "string", "examples": [ - 42 + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", + "gists_url": { + "type": "string", "examples": [ - true + "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.", - "type": "boolean", + "starred_url": { + "type": "string", "examples": [ - true + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "team_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "https://api.github.com/users/octocat/subscriptions" ] }, - "title": { - "description": "The title of the discussion.", + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "How can we improve our workflow?" + "https://api.github.com/users/octocat/orgs" ] }, - "updated_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/users/octocat/repos" ] }, - "url": { + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "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", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", + "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" ] } @@ -215858,52 +216075,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 } ] } @@ -215924,19 +216113,126 @@ "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-server@3.14/rest/teams/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "type": "string", + "examples": [ + "member" + ] + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" } }, - "post": { - "summary": "Create a discussion", - "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.", + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], - "operationId": "teams/create-discussion-in-org", + "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -215956,39 +216252,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" } } } @@ -215996,358 +216293,831 @@ } }, "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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", + "url": { "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] + "format": "uri" }, - "body_html": { + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", "type": "string", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + "member" ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "state": { + "description": "The state of the user's membership in the team.", "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "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", + "null" + ] + }, + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization_permission": { + "description": "The organization permission for this project. Only present when owner is an organization.", + "type": "string" + }, + "private": { + "description": "Whether the project is private or not. Only present when owner is an organization.", + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "read": { + "type": "boolean" + }, + "write": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "read", + "write", + "admin" + ] + } }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "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": "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": { - "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.", + "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/get-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#get-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions" }, "parameters": [ { @@ -216441,460 +217197,8 @@ } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "Hi! This is an area for us to collaborate as a team
", - "body_version": "0d495416a700fb06133c612575d92bfb", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" - } - }, - "patch": { - "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { @@ -216907,22 +217211,27 @@ "content": { "application/json": { "schema": { - "type": "object", + "type": [ + "object", + "null" + ], "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" + ] } } }, "examples": { "default": { + "summary": "Updates the permissions for the team to write for the project", "value": { - "title": "Welcome to our first team post" + "permission": "write" } } } @@ -216930,403 +217239,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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "message": { + "type": "string" }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "documentation_url": { + "type": "string" } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "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" } } } @@ -217338,19 +217273,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": [ { @@ -217372,8 +217310,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": { @@ -217390,21 +217328,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": [ { @@ -217424,1092 +217365,97 @@ "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ExternalGroups", - "description": "A list of external groups available to be connected to a team", - "type": "object", - "properties": { - "groups": { - "description": "An array of external groups available to be mapped to a team", - "type": "array", - "items": { - "type": "object", - "required": [ - "group_id", - "group_name", - "updated_at" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name of the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The time of the last update for this group", - "type": "string", - "examples": [ - "2019-06-03 22:27:15:000 -700" - ] - } - } - }, - "examples": [ - { - "group_id": 1, - "group_name": "group-azuread-test", - "updated_at": "2021-01-03 22:27:15:000 -700" - }, - { - "group_id": 2, - "group_name": "group-azuread-test2", - "updated_at": "2021-06-03 22:27:15:000 -700" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "groups": [ - { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00" - }, - { - "group_id": "456", - "group_name": "Octocat docs members", - "updated_at": "2021-03-24T11:31:04-06:00" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "external-groups" - } - }, - "patch": { - "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/link-external-idp-group-to-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" - }, - "parameters": [ + }, { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "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": "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-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 1 } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "group_id": { - "type": "integer", - "description": "External Group Id", - "examples": [ - 1 - ] - } - }, - "required": [ - "group_id" - ] - }, - "examples": { - "default": { - "value": { - "group_id": 123 - } - } - } - } - } - }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "ExternalGroup", - "description": "Information about an external group's usage and its members", - "type": "object", - "required": [ - "group_id", - "group_name", - "teams", - "members" - ], - "properties": { - "group_id": { - "description": "The internal ID of the group", - "type": "integer", - "examples": [ - 1 - ] - }, - "group_name": { - "description": "The display name for the group", - "type": "string", - "examples": [ - "group-azuread-test" - ] - }, - "updated_at": { - "description": "The date when the group was last updated_at", - "type": "string", - "examples": [ - "2021-01-03 22:27:15:000 -700" - ] - }, - "teams": { - "description": "An array of teams linked to this group", - "type": "array", - "items": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "required": [ - "team_id", - "team_name" - ], "properties": { - "team_id": { - "description": "The id for a team", + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { "type": "integer", + "format": "int64", "examples": [ 1 ] }, - "team_name": { - "description": "The name of the team", + "node_id": { "type": "string", "examples": [ - "team-test" - ] - } - } - }, - "examples": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ] - }, - "members": { - "description": "An array of external members linked to this group", - "type": "array", - "items": { - "type": "object", - "required": [ - "member_id", - "member_login", - "member_name", - "member_email" - ], - "properties": { - "member_id": { - "description": "The internal user ID of the identity", - "type": "integer", - "examples": [ - 1 - ] - }, - "member_login": { - "description": "The handle/login for the user", - "type": "string", - "examples": [ - "mona-lisa_eocsaxrs" - ] - }, - "member_name": { - "description": "The user display name/profile name", - "type": "string", - "examples": [ - "Mona Lisa" - ] - }, - "member_email": { - "description": "An email attached to a user", - "type": "string", - "examples": [ - "mona_lisa@github.com" - ] - } - } - }, - "examples": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "group_id": "123", - "group_name": "Octocat admins", - "updated_at": "2021-01-24T11:31:04-06:00", - "teams": [ - { - "team_id": 1, - "team_name": "team-test" - }, - { - "team_id": 2, - "team_name": "team-test2" - } - ], - "members": [ - { - "member_id": 1, - "member_login": "mona-lisa_eocsaxrs", - "member_name": "Mona Lisa", - "member_email": "mona_lisa@github.com" - }, - { - "member_id": 2, - "member_login": "octo-lisa_eocsaxrs", - "member_name": "Octo Lisa", - "member_email": "octo_lisa@github.com" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "external-groups" - } - }, - "delete": { - "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "tags": [ - "teams" - ], - "operationId": "teams/unlink-external-idp-group-from-team-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "teams", - "subcategory": "external-groups" - } - } - }, - "/orgs/{org}/teams/{team_slug}/members": { - "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "tags": [ - "teams" - ], - "operationId": "teams/list-members-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "Hi! This is an area for us to collaborate as a team
" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "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": "Hi! This is an area for us to collaborate as a team
" + 42 ] }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "node_id": { "type": "string", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + "MDQ6VGVhbTE=" ] }, - "created_at": { + "url": { + "description": "URL for the team", "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1" ] }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" + "https://github.com/orgs/rails/teams/core" ] }, - "node_id": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "Developers" ] }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", + "slug": { + "type": "string", "examples": [ - 42 + "justice-league" ] }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - true + "A great team." ] }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], "examples": [ - true + "closed" ] }, - "team_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "notifications_enabled" ] }, - "title": { - "description": "The title of the discussion.", + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "How can we improve our workflow?" + "push" ] }, - "updated_at": { + "members_url": { "type": "string", - "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "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": { + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -558950,472 +554288,750 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } + "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2021-02-01", - "deprecationDate": "2020-01-21", - "category": "teams", - "subcategory": "discussions" - }, - "deprecated": true - }, - "patch": { - "summary": "Update a discussion (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "examples": { - "default": { - "value": { - "title": "Welcome to our first team post" - } - } - } - } - } - }, - "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -559423,361 +555039,762 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "html_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "followers_url": { + "name": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "Justice League" ] }, - "following_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "A great team." ] }, - "gists_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "admin" ] }, - "starred_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "closed" ] }, - "subscriptions_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "notifications_enabled" ] }, - "organizations_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://github.com/orgs/rails/teams/core" ] }, - "repos_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "events_url": { + "slug": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "justice-league" ] }, - "received_events_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "uid=example,ou=users,dc=github,dc=com" ] }, "type": { + "description": "The ownership type of the team", "type": "string", - "examples": [ - "User" + "enum": [ + "enterprise", + "organization" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 37 ] }, - "user_view_type": { - "type": "string", + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ - "public" + 42 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" ] } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "Hi! This is an area for us to collaborate as a team
" + 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.", - "type": "string", + "repos_count": { + "type": "integer", "examples": [ - "0307116bbf7ced493b8d8a346c650b71" + 10 ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" + "2017-07-14T16:53:42Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" + "2017-08-17T12:37:15Z" ] }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "eyes": { - "type": "integer" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] }, - "rocket": { - "type": "integer" + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap_dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "examples": [ + "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + ] + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "examples": [ + 37 + ] + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "examples": [ + 42 ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -559786,20 +555803,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": [ { @@ -559810,20 +555827,112 @@ "schema": { "type": "integer" } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { @@ -559832,7 +555941,7 @@ "removalDate": "2021-02-01", "deprecationDate": "2020-01-21", "category": "teams", - "subcategory": "discussions" + "subcategory": "teams" }, "deprecated": true } diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml index 91ad3ef22..c7da3065c 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml @@ -4664,7 +4664,7 @@ paths: application/json: schema: *22 application/scim+json: - schema: &531 + schema: &528 title: Scim Error description: Scim Error type: object @@ -12723,7 +12723,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &366 + instances_url: &363 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -12759,7 +12759,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &367 + dismissed_reason: &364 type: - string - 'null' @@ -12770,14 +12770,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &368 + dismissed_comment: &365 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &369 + rule: &366 type: object properties: id: @@ -12822,7 +12822,7 @@ paths: description: A set of tags applicable for the rule. items: type: string - tool: &370 + tool: &367 type: object properties: name: *88 @@ -12833,26 +12833,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *89 - most_recent_instance: &371 + most_recent_instance: &368 type: object properties: - ref: &364 + ref: &361 type: string description: |- The Git reference, formatted as `refs/pull/Hi! This is an area for us to collaborate as a team
" - body_version: - description: The current version of the body content. If provided, - this update operation will be rejected if the given version - does not match the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned - for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted - to team members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *107 - 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: &563 - value: - - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *134 - - *211 - 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: *277 - examples: - default: &278 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *134 - - *211 - - &279 - 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: *277 - examples: - default: *278 - 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: - - *134 - - *211 - - *279 - 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: *277 - examples: - default: &564 - value: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://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: - - *134 - - *211 - - *279 - 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 @@ -39034,9 +38576,9 @@ paths: description: Response content: application/json: - schema: *280 + schema: *277 examples: - default: *281 + default: *278 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -39080,9 +38622,9 @@ paths: description: Response content: application/json: - schema: *282 + schema: *279 examples: - default: *283 + default: *280 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -39187,7 +38729,7 @@ paths: description: Response content: application/json: - schema: &284 + schema: &281 title: Team Membership description: Team Membership type: object @@ -39215,7 +38757,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &565 + response-if-user-is-a-team-maintainer: &560 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -39278,9 +38820,9 @@ paths: description: Response content: application/json: - schema: *284 + schema: *281 examples: - response-if-users-membership-with-team-is-now-pending: &566 + response-if-users-membership-with-team-is-now-pending: &561 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -39353,7 +38895,7 @@ paths: application/json: schema: type: array - items: &285 + items: &282 title: Team Project description: A team's access to a project. type: object @@ -39422,7 +38964,7 @@ paths: - updated_at - permissions examples: - default: &567 + default: &562 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -39487,7 +39029,7 @@ paths: parameters: - *134 - *211 - - &286 + - &283 name: project_id description: The unique identifier of the project. in: path @@ -39499,9 +39041,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *282 examples: - default: &568 + default: &563 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -39565,7 +39107,7 @@ paths: parameters: - *134 - *211 - - *286 + - *283 requestBody: required: false content: @@ -39634,7 +39176,7 @@ paths: parameters: - *134 - *211 - - *286 + - *283 responses: '204': description: Response @@ -39705,14 +39247,14 @@ paths: parameters: - *134 - *211 - - *287 - - *288 + - *284 + - *285 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &569 + schema: &564 title: Team Repository description: A team's access to a repository. type: object @@ -40355,8 +39897,8 @@ paths: parameters: - *134 - *211 - - *287 - - *288 + - *284 + - *285 requestBody: required: false content: @@ -40403,8 +39945,8 @@ paths: parameters: - *134 - *211 - - *287 - - *288 + - *284 + - *285 responses: '204': description: Response @@ -40439,9 +39981,9 @@ paths: application/json: schema: type: array - items: *289 + items: *286 examples: - response-if-child-teams-exist: &570 + response-if-child-teams-exist: &565 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -40568,7 +40110,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#get-a-project-card parameters: - - &290 + - &287 name: card_id description: The unique identifier of the card. in: path @@ -40580,7 +40122,7 @@ paths: description: Response content: application/json: - schema: &291 + schema: &288 title: Project Card description: Project cards represent a scope of work. type: object @@ -40655,7 +40197,7 @@ paths: - created_at - updated_at examples: - default: &292 + default: &289 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -40711,7 +40253,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: - - *290 + - *287 requestBody: required: false content: @@ -40741,9 +40283,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *288 examples: - default: *292 + default: *289 '304': *40 '403': *41 '401': *39 @@ -40770,7 +40312,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#delete-a-project-card parameters: - - *290 + - *287 responses: '204': description: Response @@ -40814,7 +40356,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#move-a-project-card parameters: - - *290 + - *287 requestBody: required: true content: @@ -40927,7 +40469,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#get-a-project-column parameters: - - &293 + - &290 name: column_id description: The unique identifier of the column. in: path @@ -40939,7 +40481,7 @@ paths: description: Response content: application/json: - schema: &294 + schema: &291 title: Project Column description: Project columns contain cards of work. type: object @@ -40993,7 +40535,7 @@ paths: - created_at - updated_at examples: - default: &295 + default: &292 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -41028,7 +40570,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: - - *293 + - *290 requestBody: required: true content: @@ -41053,9 +40595,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *291 examples: - default: *295 + default: *292 '304': *40 '403': *41 '401': *39 @@ -41080,7 +40622,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#delete-a-project-column parameters: - - *293 + - *290 responses: '204': description: Response @@ -41109,7 +40651,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#list-project-cards parameters: - - *293 + - *290 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -41130,7 +40672,7 @@ paths: application/json: schema: type: array - items: *291 + items: *288 examples: default: value: @@ -41189,7 +40731,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/cards#create-a-project-card parameters: - - *293 + - *290 requestBody: required: true content: @@ -41233,9 +40775,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *288 examples: - default: *292 + default: *289 '304': *40 '403': *41 '401': *39 @@ -41291,7 +40833,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#move-a-project-column parameters: - - *293 + - *290 requestBody: required: true content: @@ -41351,7 +40893,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#get-a-project parameters: - - *286 + - *283 responses: '200': description: Response @@ -41359,7 +40901,7 @@ paths: application/json: schema: *232 examples: - default: &296 + default: &293 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -41413,7 +40955,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#update-a-project parameters: - - *286 + - *283 requestBody: required: false content: @@ -41464,7 +41006,7 @@ paths: application/json: schema: *232 examples: - default: *296 + default: *293 '404': description: Not Found if the authenticated user does not have access to the project @@ -41504,7 +41046,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/projects#delete-a-project parameters: - - *286 + - *283 responses: '204': description: Delete Success @@ -41547,7 +41089,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#list-project-collaborators parameters: - - *286 + - *283 - 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 @@ -41604,7 +41146,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/collaborators#add-project-collaborator parameters: - - *286 + - *283 - *8 requestBody: required: false @@ -41659,7 +41201,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: - - *286 + - *283 - *8 responses: '204': @@ -41691,7 +41233,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: - - *286 + - *283 - *8 responses: '200': @@ -41762,7 +41304,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#list-project-columns parameters: - - *286 + - *283 - *4 - *5 responses: @@ -41772,7 +41314,7 @@ paths: application/json: schema: type: array - items: *294 + items: *291 examples: default: value: @@ -41810,7 +41352,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/projects-classic/columns#create-a-project-column parameters: - - *286 + - *283 requestBody: required: true content: @@ -41834,7 +41376,7 @@ paths: description: Response content: application/json: - schema: *294 + schema: *291 examples: default: value: @@ -41899,7 +41441,7 @@ paths: resources: type: object properties: - core: &297 + core: &294 title: Rate Limit type: object properties: @@ -41916,20 +41458,20 @@ paths: - remaining - reset - used - graphql: *297 - search: *297 - code_search: *297 - source_import: *297 - integration_manifest: *297 - code_scanning_upload: *297 - actions_runner_registration: *297 - scim: *297 - dependency_sbom: *297 - code_scanning_autofix: *297 + graphql: *294 + search: *294 + code_search: *294 + source_import: *294 + integration_manifest: *294 + code_scanning_upload: *294 + actions_runner_registration: *294 + scim: *294 + dependency_sbom: *294 + code_scanning_autofix: *294 required: - core - search - rate: *297 + rate: *294 required: - rate - resources @@ -42034,14 +41576,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository parameters: - - *287 - - *288 + - *284 + - *285 responses: '200': description: Response content: application/json: - schema: *298 + schema: *295 examples: default-response: summary: Default response @@ -42540,7 +42082,7 @@ paths: status: disabled '403': *41 '404': *24 - '301': *299 + '301': *296 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42558,8 +42100,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#update-a-repository parameters: - - *287 - - *288 + - *284 + - *285 requestBody: required: false content: @@ -42776,10 +42318,10 @@ paths: description: Response content: application/json: - schema: *298 + schema: *295 examples: - default: *300 - '307': &301 + default: *297 + '307': &298 description: Temporary Redirect content: application/json: @@ -42824,8 +42366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository parameters: - - *287 - - *288 + - *284 + - *285 responses: '204': description: Response @@ -42847,7 +42389,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': *301 + '307': *298 '404': *24 '409': *139 x-github: @@ -42871,11 +42413,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *287 - - *288 + - *284 + - *285 - *4 - *5 - - &318 + - &315 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -42898,7 +42440,7 @@ paths: type: integer artifacts: type: array - items: &302 + items: &299 title: Artifact description: An artifact type: object @@ -42984,7 +42526,7 @@ paths: - expires_at - updated_at examples: - default: &319 + default: &316 value: total_count: 2 artifacts: @@ -43043,9 +42585,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#get-an-artifact parameters: - - *287 - - *288 - - &303 + - *284 + - *285 + - &300 name: artifact_id description: The unique identifier of the artifact. in: path @@ -43057,7 +42599,7 @@ paths: description: Response content: application/json: - schema: *302 + schema: *299 examples: default: value: @@ -43094,9 +42636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#delete-an-artifact parameters: - - *287 - - *288 - - *303 + - *284 + - *285 + - *300 responses: '204': description: Response @@ -43120,9 +42662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#download-an-artifact parameters: - - *287 - - *288 - - *303 + - *284 + - *285 + - *300 - name: archive_format in: path required: true @@ -43159,14 +42701,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: - - *287 - - *288 + - *284 + - *285 responses: '200': description: Response content: application/json: - schema: *304 + schema: *301 examples: default: value: @@ -43192,14 +42734,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: - - *287 - - *288 + - *284 + - *285 responses: '200': description: Response content: application/json: - schema: &305 + schema: &302 title: Actions cache usage policy for repository description: GitHub Actions cache usage policy for repository. type: object @@ -43212,7 +42754,7 @@ paths: required: - repo_cache_size_limit_in_gb examples: - default: &306 + default: &303 value: repo_cache_size_limit_in_gb: 14 x-github: @@ -43233,8 +42775,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: - - *287 - - *288 + - *284 + - *285 responses: '204': description: Response @@ -43242,9 +42784,9 @@ paths: required: true content: application/json: - schema: *305 + schema: *302 examples: - selected_actions: *306 + selected_actions: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43264,11 +42806,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: - - *287 - - *288 + - *284 + - *285 - *4 - *5 - - &307 + - &304 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/