Improve Users REST API Documentation
When referring to the Users REST API Documentation the @gitlab-org/developer-relations/contributor-success team noticed a few oddities/inconsistencies.
Most importantly, the parameters for the List users endpoint do not seem to be documented in the standard way.
It appears that the For administrators section includes a table listing some parameters, but I don't think it's an exhaustive list (perhaps these are just the parameters which are ONLY available to administrators?)
If you take a look at the List all projects API docs as a good example of the standard tabular parameter format.
Some of the parameters are mentioned in examples:
But I think an exhaustive list can be found in the API code itself: https://gitlab.com/gitlab-community/gitlab/-/blob/a55b74e0b0a107ab8e6ddc73a8b3aadff0bc36d7/lib/api/users.rb#L86
There are some other things which bug me- for example: List current user doesn't really make sense to me (and the text even reads Get current user.
). So feel free to tweak anything else you spot which looks wrong
Implementation Plan
Update https://gitlab.com/gitlab-community/gitlab/-/blob/master/doc/api/users.md
to list the list users
parameters in a table format.
Make any other fixes/improvements while there :)