Skip to content

Fix documentation for commit discussions

Clayton Carter requested to merge (removed):claytonrcarter-master-patch-07676 into master

What does this MR do and why?

I may be wrong (it happens often!) but the API docs for commit discussions appear to be wrong and inconsistent when it comes to the expected type of both commit_id and discussion_id. The docs state that they should both be int (in most places), but in reality they both seem to be string (SHA for commits, and something SHA-like for discussions).

Add'l comments:

  • I don't know much about Rails, so I haven't been able to confirm this via the controller code, but I have played w/ the API via curl and, this update seems to be consistent w/ what I saw.
  • The commit_id used in the related examples appears to have just been copy-pasted from the other examples on this page. Those examples use issue and MR ids, which are int.
  • I also updated the URL for the final example (for "Delete a commit thread note"). It was just using the wrong URL.
  • !67406 (merged) made a similar change to the docs for the "Create new commit thread" endpoint about a year ago

Thanks for your consideration!

Screenshots or screen recordings

n/a

How to set up and validate locally

I believe that you can just preview the rendered Markdown file. As for confirming that these updates match the actual code, I don't know.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports