Fix attribute names for autocomplete and SSH key rate limits in settings API docs
What does this MR do?
Corrects four attribute names in doc/api/settings.md that do not match
what PUT /application/settings accepts and GET /application/settings
returns:
| Documented | Actual |
|---|---|
autocomplete_users |
autocomplete_users_limit |
autocomplete_users_unauthenticated |
autocomplete_users_unauthenticated_limit |
users_api_limit_keys |
users_api_limit_ssh_keys |
users_api_limit_key |
users_api_limit_ssh_key |
lib/api/settings.rb and app/models/application_setting.rb have used the
"Actual" names since these settings were introduced in GitLab 17.10. Verified
on GitLab 19.4.1-ee and 19.5.0-pre.
Related issues
Closes #631701
Author's checklist
- Optional. Consider taking the GitLab Technical Writing Fundamentals course.
- Follow the:
- If you're adding a new page, add the product availability details under the H1 topic title.
- If you are a GitLab team member, request a review based on:
- The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"~"backend"~"type::bug"~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
- If the content requires it, ensure the information is reviewed by a subject matter expert.
- Technical writer review items:
- Ensure docs metadata is present and up-to-date.
- Ensure the appropriate labels are added to this MR.
- Ensure a release milestone is set.
- If relevant to this MR, ensure content topic type principles are in use, including:
- The headings should be something you'd do a Google search for. Instead of
Default behavior, say something likeDefault behavior when you close an issue. - The headings (other than the page title) should be active. Instead of
Configuring GDK, say something likeConfigure GDK. - Any task steps should be written as a numbered list.
- If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
- The headings should be something you'd do a Google search for. Instead of
- Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.