Skip to content

Create new merge request note API - Docs are misleading. Should the payload be a search parameter or a body parameter?

Problem to solve

The documentation for the notes API, specifically the Merge Request Notes API, mentions the POST request required to create a new note. This request includes a set of parameters that are accepted:

image

However, making a request with these parameters as body arguments results in a Bad Request failure. Note, I guessed body arguments since its a POST request and their was no example suggesting otherwise.

When looking at the modify note endpoint, it shows that the body parameter is actually a search parameter.

What is the correct documentation for these endpoints?

Proposal

Perhaps updating the create note docs to include an example to make it clear what is/isnt a search parameter argument.

Who can address the issue

Anyone once the correct docs are known