Skip to content

Include `title` field in the custom roles documentation generator

We want to update the documentation generator for custom roles to better fit the need of customers.

The new format should be:

Permission Description API Attribute Scope Introduced In

Headers

  • Permisison: "Pretty" version of the permission title for user to quickly read. Can potentially be used on Create Role or View Permissions view (future). (this will be the title field we are adding in #482750 (closed))
  • Description (no change). Required Permission in the description.
  • Attribute: Name of permission in code and API (Previously Name)
  • Scope: Inspired from Audit Events. Include ability to scope to group or project level.
    • Group, Project
    • Project
  • Introduced In (linked) (no change)

Remove

  • Feature Flag
  • Enable In

Examples:

Permission Description API Attribute Scope Introduced In
Manage CI/CD Variables Create, read, update, and delete CI/CD variables. admin_cicd_variables Group, Project 16.10
Manage project access tokens ... ... Project ...