[API Docs inaccuracy] <Get a Commit Comment>

Open Beginner friendly
#6,147 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
openapi
Domain
api, documentation

Research direction

Start with the linked REST API documentation for the Get a Commit Comment endpoint and compare its response example with the inline and regular comment examples in the issue. Update the API description so both comment forms are documented, including a numeric line for inline comments and null for regular comments.

Written by the indexing model from the issue text.

Description

documentation

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: https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e#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: https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e#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

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.