Discussions¶

Discussions are used to start topics and gather opinions within a repository or organization. The API lets you create, update, and delete discussions under a repository or organization, manage comments and replies to comments, and filter the list by category, title, and popularity.

The repository and organization endpoints are symmetric; their parameters differ only in the scope identifier.

Objects¶

Identification¶

• Repository discussions use owner + repo to identify the repository and number to identify the discussion number; the path segment is discuss.
• Organization discussions use org to identify the organization, and the number also uses number.
• Comments are identified by id (written as comment_id on the organization side); the reply path is comment/{id}/reply.

Common tasks¶

Notes¶

• The path segment is discuss (not discussions), the comment segment is the singular comment, and replies use comment/{id}/reply; a single missing letter returns 404.
• The endpoint path for getting the repository discussion comment reply list uses * placeholders: GET /api/v5/repos/*/*/discuss/*/comment/*/reply, which is inconsistent with the {owner}/{repo} style used by the rest of the group.
• Repository discussions and organization discussions are two separate sets of endpoints; /repos/{owner}/{repo}/discuss… and /orgs/{org}/discuss… cannot be used interchangeably.
• The body of both comments and replies supports Markdown; submit the raw Markdown text.
• The details endpoint returns the vote and vote options, but this group has no endpoint for creating votes or writing labels; these two fields are read-only.

Endpoints¶

This module contains 22 endpoints.