Skip to content

Update pipeline triggers API endpoint

Marcel Amirault requested to merge docs-pipelines-trigger-api into master

What does this MR do?

We noticed that this endpoint for triggering pipelines with a trigger token is detailed in the CI/CD settings themselves, but it isn't actually in the docs for pipeline triggers. After a bit of testing, I'm adding in the endpoint for triggering a pipeline with a pipeline trigger token:

  • POST /projects/:id/trigger/pipeline

As part of this, I'm tweaking some of the intro sentences and headers to be slightly clearer as to what we are talking about on this page.

Related issues

Resolves #352259 (closed)

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Marcel Amirault

Merge request reports