Loading
Draft: docs: document duo_remote_flows_enabled API
Relates to issue #585775
Changes
This MR adds comprehensive documentation for managing GitLab Duo remote flows via the API.
doc/api/groups.md
- Added
duo_remote_flows_availabilityattribute to the Update group attributes table with description explaining it's a convenience attribute for Premium and Ultimate tiers - Added explanatory note after the attributes table clarifying the relationship between
duo_remote_flows_availability,duo_remote_flows_enabled, andlock_duo_remote_flows_enabled - Added three example API requests demonstrating:
- Getting group settings including
duo_remote_flows_availability - Enabling GitLab Duo remote flows using
duo_remote_flows_availability=true - Disabling GitLab Duo remote flows using
duo_remote_flows_availability=false
- Getting group settings including
doc/api/settings.md
The settings.md file already contains complete documentation:
duo_remote_flows_enabledandduo_remote_flows_availabilitydocumented in the Available settings tablelock_duo_remote_flows_enabledalso documented- Comprehensive note explaining the relationship between these attributes
- Complete example API requests showing how to get and set these values
Key Documentation Points
-
Two Approaches: Users can manage GitLab Duo remote flows using either:
- The convenience attribute
duo_remote_flows_availability(simpler, manages both enable and lock settings) - Direct control with
duo_remote_flows_enabledandlock_duo_remote_flows_enabled(granular control)
- The convenience attribute
-
Behavior:
- Setting
duo_remote_flows_availability=trueenables remote flows and unlocks the setting - Setting
duo_remote_flows_availability=falsedisables remote flows and locks the setting
- Setting
-
Availability: These features are available for Premium and Ultimate tiers only
Edited by Duo Developer