docs(api): add documentation for project feature flags

amimas · amimas · commit 14fcc916a55d · 2026-03-15T17:53:35.000-04:00
This adds the documentation for Project Feature Flags and Feature Flag
User Lists.

It includes:
- New documentation pages for Feature Flags and User Lists.
- Updates to the Project documentation to reference the new managers.
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -49,6 +49,8 @@ API examples
    gl_objects/pipelines_and_jobs
    gl_objects/projects
    gl_objects/project_access_tokens
+   gl_objects/project_feature_flags
+   gl_objects/project_feature_flag_user_lists
    gl_objects/protected_branches
    gl_objects/protected_container_repositories
    gl_objects/protected_environments
diff --git a/docs/gl_objects/project_feature_flag_user_lists.rst b/docs/gl_objects/project_feature_flag_user_lists.rst
@@ -0,0 +1,51 @@
+#######################
+Project Feature Flag User Lists
+#######################
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagUserList`
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagUserListManager`
+  + :attr:`gitlab.v4.objects.Project.feature_flags_user_lists`
+
+* GitLab API: https://docs.gitlab.com/ee/api/feature_flag_user_lists.html
+
+Examples
+--------
+
+List user lists::
+
+    user_lists = project.feature_flags_user_lists.list()
+
+Get a user list::
+
+    user_list = project.feature_flags_user_lists.get(list_iid)
+
+Create a user list::
+
+    user_list = project.feature_flags_user_lists.create({
+        'name': 'my_user_list',
+        'user_xids': 'user1,user2,user3'
+    })
+
+Update a user list::
+
+    user_list.name = 'updated_list_name'
+    user_list.user_xids = 'user1,user2'
+    user_list.save()
+
+Delete a user list::
+
+    user_list.delete()
+
+Search for a user list::
+
+    user_lists = project.feature_flags_user_lists.list(search='my_list')
+
+See also
+--------
+
+* :doc:`project_feature_flags`
diff --git a/docs/gl_objects/project_feature_flags.rst b/docs/gl_objects/project_feature_flags.rst
@@ -0,0 +1,63 @@
+#####################
+Project Feature Flags
+#####################
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectFeatureFlag`
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagManager`
+  + :attr:`gitlab.v4.objects.Project.feature_flags`
+
+* GitLab API: https://docs.gitlab.com/ee/api/feature_flags.html
+
+Examples
+--------
+
+List feature flags::
+
+    flags = project.feature_flags.list()
+
+Get a feature flag::
+
+    flag = project.feature_flags.get('my_feature_flag')
+
+Create a feature flag::
+
+    flag = project.feature_flags.create({'name': 'my_feature_flag', 'version': 'new_version_flag'})
+
+Create a feature flag with strategies::
+
+    flag = project.feature_flags.create({
+        'name': 'my_complex_flag',
+        'version': 'new_version_flag',
+        'strategies': [{
+            'name': 'userWithId',
+            'parameters': {'userIds': 'user1,user2'}
+        }]
+    })
+
+Update a feature flag::
+
+    flag.description = 'Updated description'
+    flag.save()
+
+Rename a feature flag::
+
+    # You can rename a flag by changing its name attribute and calling save()
+    flag.name = 'new_flag_name'
+    flag.save()
+
+    # Alternatively, you can use the manager's update method
+    project.feature_flags.update('old_flag_name', {'name': 'new_flag_name'})
+
+Delete a feature flag::
+
+    flag.delete()
+
+See also
+--------
+
+* :doc:`project_feature_flag_user_lists`
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -409,6 +409,44 @@ Search projects by custom attribute::
     project.customattributes.set('type', 'internal')
     gl.projects.list(custom_attributes={'type': 'internal'}, get_all=True)
 
+Project feature flags
+=====================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectFeatureFlag`
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagManager`
+  + :attr:`gitlab.v4.objects.Project.feature_flags`
+
+* GitLab API: https://docs.gitlab.com/ee/api/feature_flags.html
+
+Examples
+--------
+
+See :doc:`project_feature_flags`.
+
+Project feature flag user lists
+===============================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagUserList`
+  + :class:`gitlab.v4.objects.ProjectFeatureFlagUserListManager`
+  + :attr:`gitlab.v4.objects.Project.feature_flags_user_lists`
+
+* GitLab API: https://docs.gitlab.com/ee/api/feature_flag_user_lists.html
+
+Examples
+--------
+
+See :doc:`project_feature_flag_user_lists`.
+
 Project files
 =============
 
