Skip to content

Add OpenAPI documentation for ProjectPushRules

Joe Woodward requested to merge docs/377029-project-push-rule-endpoint into master

What does this MR do and why?

https://gitlab.com/gitlab-org/gitlab/-/issues/377029 Adds documentation to project push rule endpoints.

How to set up and validate locally

  1. git checkout docs/377029-project-push-rule-endpoint
  2. rake gitlab:openapi:generate
  3. visit editor.swagger.io
  4. File > Import File > find doc/api/openapi/openapi_v2.yaml and import
  5. Find the relevant docs under projects and push_rules (tagged with both so will be included in both sections) and verify against https://docs.gitlab.com/ee/api/projects.html#push-rules

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