Skip to content

Draft: Clarify API endpoint /runners/all

Chantal Lawrence requested to merge chantalskye-runners-api-doc-update into master

What does this MR do and why?

The first paragraph in the existing documentation implies that /runners/all is an endpoint available to all:

Runners API ALL TIERS
Pagination is available on the following API endpoints (they return 20 items by default):

GET /runners
GET /runners/all
GET /runners/:id/jobs
GET /projects/:id/runners
GET /groups/:id/runners

A couple of paragraphs down /Runners/all is correctly identified as available only to self managed.

This update removes GET /runners/all from the list of API endpoints available to all tiers. I have reordered the page so the next paragraph relates specifically to the GET /runners/all endpoint which is identified as available only to Self Managed.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

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