Skip to content

Modify misleading parameter description

Miguel Medina Ballesteros requested to merge maximetinu/gitlab:fix-misleading-parameter-description into master

What does this MR do and why?

The documentation of the ref parameter on the Pipelines API made me thought it would be a commit ID, but it's not.

https://docs.gitlab.com/ee/api/pipelines.html#create-a-new-pipeline

It expects a branch name, not a commit ID. I didn't realized that until I looked at the example below:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipeline?ref=main"

This MR aims to fix that by making the description of the parameter more explicit.

MR acceptance checklist

Merge request reports