Skip to content

[API Docs inaccuracy] <Get a Commit Comment> #6147

@pranavcivi

Description

@pranavcivi

API Docs Inaccuracy

Description

Referring to REST API documentation for GitHub commit comments
There are two types of commit comments, inline and regular.
Inline comment html_url format: {owner}/{repo}/commit/{commit sha}#r{id}
Inline comments also have "line":{number} as part of the API response
Example inline comment: octocat/Hello-World@553c207#r3291273

Regular comment html_url format: {owner}/{repo}/commit/{commit sha}#commitcomment-{id}
Regular comments also have "line": null as part of the API response (since they are not attached to any line of code)
Example regular comment: octocat/Hello-World@553c207#commitcomment-292400

This differs from the format shows in the api docs: Get a commit comment
Only regular comments are documented and it lists a nonnull line number, which is only found in inline comments

Expected

Can we have both versions of commit comments documented? (Inline and regular)
The example regular comment should display a null value for line while the inline comment displays a value for line

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions