Add missing API descriptions

Note

This issue address an existing engineering/technical implementation, and is not strictly focused on documentation

Problem to solve

GitLab's API content is missing attributes descriptions (46 files, 165 missing descriptions).

Proposal

Currently plan is to do this with a small team of technical writers. Deves team to support additional questions.

• Add missing descriptions
  • Analyze list of files to identify any missing descriptions
  • Compare against existing markdown documentation to reuse content
  • Identify any attributes that need further context from devs
• Identify any false positives. Files that don't have any missing descriptions.
• Create a plan for dealing with internal/non-customer facing APIs.

Note

Remember to remove any fixed files from .rubocop_todo/api/parameter_description.yml

Other links/references

• Ensure API params have a description (!206279 - merged)
• [Rubocop] Update param desc linter (!208206 - merged)
• List of files with missing descriptions.
• Working google sheet.
  • Pardon the Google sheet, it's just easier to keep things organized. This will be removed after work is completed.