Skip to content

Documentation: Api - Resources Gitlab_ci_yml templates

Alexis Sánchez requested to merge (removed):doc-api-gitlab-ci-ymls-api into master

What does this MR do?

  • Add example request, to make more standard and coherent, there is an "example response", in that case should be define the "example request".
  • Update the output of the API.
  • define as "plaintext" the definition of the endpoit, Fenced code blocks should have a language specified [Context: "```"]

Author's checklist

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports