Skip to content

Update docs on list-ssh-keys with pagination

Josh Chorlton requested to merge jchorl/gitlab:jchorl/listsshpaginated into master

What does this MR do and why?

Minor docs change to indicate that the List SSH Keys API is paginated. Empirically, I have found this to be true.

Screenshots or screen recordings

curl --header "Authorization: Bearer <redacted>" 'https://gitlab.com/api/v4/user/keys?page=1&per_page=20' 2>/dev/null | jq length
20
curl --header "Authorization: Bearer <redacted>" 'https://gitlab.com/api/v4/user/keys?page=2&per_page=20' 2>/dev/null | jq length
20
curl --header "Authorization: Bearer <redacted>" 'https://gitlab.com/api/v4/user/keys?page=3&per_page=20' 2>/dev/null | jq length
10

How to set up and validate locally

Well, these are docs. If you want to validate the functionality of the API, you can add a bunch of SSH keys and execute the curls above.

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