discussions
Overview
Name | discussions |
Type | Resource |
Id | github.teams.discussions |
Fields
Name | Datatype | Description |
---|---|---|
author | object | A GitHub user. |
body | string | The main text of the discussion. |
body_html | string | |
body_version | string | 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. |
comments_count | integer | |
comments_url | string | |
created_at | string | |
html_url | string | |
last_edited_at | string | |
node_id | string | |
number | integer | The unique sequence number of a team discussion. |
pinned | boolean | Whether or not this discussion should be pinned for easy retrieval. |
private | boolean | Whether or not this discussion should be restricted to team members and organization administrators. |
reactions | object | |
team_url | string | |
title | string | The title of the discussion. |
updated_at | string | |
url | string |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_discussion_in_org | SELECT | discussion_number, org, team_slug | Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.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} . |
get_discussion_legacy | SELECT | discussion_number, team_id | Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint. Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope. |
list_discussions_in_org | SELECT | org, team_slug | List all discussions on a team's page. OAuth access tokens require the read:discussion scope.Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions . |
list_discussions_legacy | SELECT | team_id | Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.List all discussions on a team's page. OAuth access tokens require the read:discussion scope. |
create_discussion_in_org | INSERT | org, team_slug, data__body, data__title | Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details. Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions . |
delete_discussion_in_org | DELETE | discussion_number, org, team_slug | Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.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} . |
create_discussion_legacy | EXEC | team_id, data__body, data__title | Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details. |
delete_discussion_legacy | EXEC | discussion_number, team_id | Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope. |
update_discussion_in_org | EXEC | discussion_number, org, team_slug | Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.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} . |
update_discussion_legacy | EXEC | discussion_number, team_id | Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint. Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope. |