Loading
docs(repository_storage_moves): fix broken API doc anchors
What does this MR do?
GitLab renamed the section titles on the three repository storage moves API pages, so 24 doc links in the three storage move services point at anchors that no longer exist. The pages open, but at the top instead of at the method.
The three files follow the same pattern, so they are fixed together:
| Method | Old anchor (group / project / snippet) | New anchor |
|---|---|---|
RetrieveAllStorageMoves + options |
#retrieve-all-<x>-repository-storage-moves |
#list-all-<x>-repository-storage-moves |
RetrieveAllStorageMovesFor<X> |
#retrieve-all-repository-storage-moves-for-a-(single-)<x> |
#list-all-repository-storage-moves-for-a-<x> |
GetStorageMove |
#get-a-single-<x>-repository-storage-move |
#retrieve-a-<x>-repository-storage-move |
GetStorageMoveFor<X> |
#get-a-single-repository-storage-move-for-a-<x> |
#retrieve-a-repository-storage-move-for-a-<x> |
ScheduleStorageMoveFor<X> + options (group, project) |
#schedule-a-repository-storage-move-for-a-<x> |
group: #create-a-group-repository-storage-move, project: #create-a-repository-storage-move-for-a-project |
ScheduleAllStorageMoves + options (group, project) |
#schedule-repository-storage-moves-for-all-<x>s-on-a-storage-shard |
group: #create-group-repository-storage-moves-for-a-storage-shard, project: #create-repository-storage-moves-for-all-projects-on-a-storage-shard |
The snippet page still uses "Schedule ..." for the two POST sections, so those snippet links were already correct and are not changed.
Pages:
- https://docs.gitlab.com/api/group_repository_storage_moves/
- https://docs.gitlab.com/api/project_repository_storage_moves/
- https://docs.gitlab.com/api/snippet_repository_storage_moves/
This is the same kind of fix as !2723 (merged), !2777 (merged) and !2779 (merged).
How was this checked?
- Every new anchor was checked against the
idvalues in the live HTML of the three pages. After the change, all 34 links in the three files resolve (before: 24 broken). - Each mapping was checked against the route constant the function uses (for example
routeGroupsIDRepositoryStorageMovesID->GET /groups/:group_id/repository_storage_moves/:repository_storage_id-> "Retrieve a repository storage move for a group"). - Comment-only change.
This contribution was prepared with the help of an AI assistant. I reviewed the changes and take responsibility for them.