Configure pull mirroring: improve API docs
Problem to solve
Customer feedback captured in https://gitlab.com/gitlab-com/account-management/pre-sales/sap-ns2/-/issues/32 that https://docs.gitlab.com/ee/api/projects.html#configure-pull-mirroring-for-a-project needs clarification.
The user wanted API endpoints for:
- Updating a pull mirror - per @phikai "This isn't possible, as it's not something that's possible in the UI. Pull mirrors can't be edited once they're created and need to be created again if settings change:"
-
Deleting a pull mirror - per Kai "I'd expect that this would be done via the
edit project
endpoint where you'd adjust the values." - Listing a pull mirror - per Kai "This would also be done by getting a single project endpoint which should return any information about configured mirrors."
Customer response: "The documentation listed https://docs.gitlab.com/ee/api/projects.html#configure-pull-mirroring-for-a-project is not clear that the edit project
endpoint is to be used and is pretty lacking in general when compared to other sections of that page. Other sections provide example URLs for the endpoint usage, but the section for configuring a pull mirror does not."
Further details
Amy can help polish the end result, but the example commands and output should come from a member of the groupcode review team.
Proposal
- To the section for configuring a pull mirror:
- add example
curl
commands and output for using the endpoint - ensure the situations described in the first paragraph are addressed in the example(s)
- add example
- Add a statement to https://docs.gitlab.com/ee/api/projects.html#configure-pull-mirroring-for-a-project that users should use the
edit project
endpoint to accomplish the work.
Who can address the issue
Engineers on the groupcode review team.