Skip to content

Update documentation "list all projects" api endpoint

Alexis Sánchez requested to merge aasanchez/gitlab:list-all-projects into master

What does this MR do?

The current documentation for the API endpoint for projects is relatively outdated; this merge request intends to kick off my contributions to this task, if everything goes well, I will create a series of MR until this important endpoint is fully updated.

The work here is:

  • Update the response of the enpoint get all projects.
  • Update to the documentation style related to URL, and others.
  • Use the output for other sections of the documentation to complement the endpoint, like owner and custom atributes.

Author's checklist

Reviewer's 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.
    • Ensure a release milestone is set.
    • 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.

documentation typemaintenance Community contribution

Edited by Alexis Sánchez

Merge request reports