Skip to content

Update doc/api/jobs.md

Farzad requested to merge (removed):docs/update-api-jobs into master

What does this MR do?

Improves Jobs API documentation to include information regarding paginated data.

Related issues

I had this issue myself and spent hours debugging my script only to realize the API does not return all jobs and is in fact paginated. Following issues seem to be relevant as well, which hints that this may be a common misunderstanding:

Related to #22976

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