OpenAPI: Add endpoint to create note on MR
Main changes
This commit add a missing operation on OpenAPI V3 document,
POST /projects/{id}/merge_requests/{merge_request_iid}/notes.
This operation is described on the entire Markdown documentation
of the API, referenced with externalDocs link:
https://docs.gitlab.com/api/notes/#create-new-merge-request-note
Bonus with this MR
Attached to Bump.sh CLI and GitLab script, we can use this endpoint to post a note of given MR, with structural change of OpenAPI when its relevant.
For example in this MergeRequest,
we should discover that a new operation
POST /projects/{id}/merge_requests/{merge_request_iid}/notes
has been added to OpenAPI document
(yes it's meta
Important point / remaining questions:
- operationId:
I followed pattern of other operations to guess value here:
postApiV4ProjectsIdMergeRequestsMergeRequestIidNotes
Is there a specific rule to apply?
-
bodyparameter: body or query destination?
Documentation mentions it as a query parameter, but I noticed it works well as body parameter.
In this commit suggestion, I assume to add this parameter in requestBody
- optional parameters
created_at,internalandmerge_request_diff_head_sha: Destination is not specified in markdown documentation, but I tested operation with Bump.sh explorer, and confirmed it was some query parameters.