Loading
Document GitLab Duo remote flows API attributes
What does this MR do?
Documents how to set GitLab Duo remote flows through the REST API. Every claim was checked against the current code.
doc/api/groups.md, Create a group and Update group attributes: addsduo_remote_flows_availability, the only remote flows parameter thatPOST /groupsandPUT /groups/:idaccept. Both endpoints share:optional_params(ee/lib/ee/api/helpers/groups_helpers.rb). The row explains that:trueturns remote flows on and unlocks the setting.falseturns remote flows off and enforces the setting for subgroups and projects.- The endpoints don't accept
duo_remote_flows_enableddirectly. - The parameter is ignored, but the request still succeeds, when a parent group or the instance enforces the setting (
ee/app/models/ee/namespace_setting.rb). On create, the parent's lock is resolved throughparent_idbefore the group is saved, so a subgroup created under a locked parent inherits the locked value.
doc/api/groups.md, Retrieve a group: adds a history note for theduo_remote_flows_enabledandlock_duo_remote_flows_enabledresponse attributes. The companion code MR !269538 (merged) added and documented those attributes, and it has merged.doc/api/settings.md:- Adds
duo_remote_flows_enabledto the GET response list.lock_duo_remote_flows_enabledisn't listed there, because the GET response doesn't expose it (it's not invisible_attributes). - Adds both
duo_remote_flows_enabledandlock_duo_remote_flows_enabledto the Available settings table, becausePUT /application/settingsaccepts both. Defaults come fromdb/structure.sql, and they're Self-Managed only because GitLab.com strips the setting (ee/lib/ee/api/settings.rb).
- Adds
This replaces the closed draft !224802 (closed). Its review found that it wrongly listed duo_remote_flows_availability as a settings API parameter.
Related issues
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. Not applicable, no new page.
- If you are a GitLab team member, request a review based on:
- The documentation page's metadata.
- The associated Technical Writer.
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 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.
- Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Sebastian Rehm