Fetch comments for a report's implementation PR

v1.0.0

Fetch the pull request's conversation comments and inline review comments, merged chronologically, via the team's GitHub integration.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "project_id": {
      "type": "string"
    },
    "pull_request_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "id",
    "project_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Response for the PR comments endpoint — conversation and review comments merged chronologically.",
  "required": [
    "comments"
  ],
  "properties": {
    "comments": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "One comment on a pull request — a conversation comment or an inline review comment.",
        "required": [
          "author",
          "author_avatar_url",
          "body",
          "comment_type",
          "commit_id",
          "created_at",
          "diff_hunk",
          "id",
          "in_reply_to_id",
          "line",
          "path",
          "reactions",
          "side",
          "start_line",
          "url"
        ],
        "properties": {
          "author": {
            "type": [
              "string",
              "null"
            ],
            "description": "Comment author's GitHub login."
          },
          "author_avatar_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "Author's GitHub avatar URL."
          },
          "body": {
            "type": "string",
            "description": "Comment body (GitHub-flavored markdown)."
          },
          "comment_type": {
            "description": "'conversation' for a PR discussion comment, 'review' for an inline code-review comment.\n\n* `conversation` - conversation\n* `review` - review",
            "type": "object"
          },
          "commit_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "SHA of the commit the review comment was made against (review comments only)."
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "ISO 8601 creation timestamp."
          },
          "diff_hunk": {
            "type": [
              "string",
              "null"
            ],
            "description": "Diff hunk excerpt the review comment applies to (review comments only)."
          },
          "id": {
            "type": "string",
            "description": "GitHub comment id."
          },
          "in_reply_to_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "Id of the thread root comment this one replies to; null for thread roots and conversation comments."
          },
          "line": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Line in the diff the review comment is anchored to — the end line for multi-line comments (review comments only; null when the comment is outdated relative to the PR head)."
          },
          "path": {
            "type": [
              "string",
              "null"
            ],
            "description": "File path the review comment is anchored to (review comments only)."
          },
          "reactions": {
            "type": "array",
            "description": "Emoji reactions on this review comment, one entry per reactor.",
            "items": {
              "type": "object",
              "description": "One emoji reaction on a review comment, with the reactor so the viewer's own can be toggled.",
              "required": [
                "content",
                "id",
                "user_login"
              ],
              "properties": {
                "content": {
                  "type": "string",
                  "description": "Reaction key: '+1', '-1', 'laugh', 'hooray', 'confused', 'heart', 'rocket', or 'eyes'."
                },
                "id": {
                  "type": "string",
                  "description": "GitHub reaction id (needed to remove it)."
                },
                "user_login": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "GitHub login of the user who added the reaction."
                }
              }
            }
          },
          "side": {
            "description": "Diff side the review comment is anchored to: 'LEFT' = deletions, 'RIGHT' = additions (review comments only).\n\n* `LEFT` - LEFT\n* `RIGHT` - RIGHT",
            "type": "object"
          },
          "start_line": {
            "type": [
              "integer",
              "null"
            ],
            "description": "First line of a multi-line review comment's range (review comments only)."
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "Link to the comment on GitHub."
          }
        }
      }
    }
  }
}