Skip to content

docs: document Hub API custom role assignment for members and teams - #25996

Open
akristen wants to merge 2 commits into
docker:mainfrom
akristen:role-assignment-teams-api
Open

docs: document Hub API custom role assignment for members and teams#25996
akristen wants to merge 2 commits into
docker:mainfrom
akristen:role-assignment-teams-api

Conversation

@akristen

@akristen akristen commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document that member PUT role accepts a custom role name, not only owner | editor | member.
  • Document role on team PATCH (core or custom role name) and on org_group so the PATCH 200 can include the assigned role.
  • Add Editor to org_member.role (title case). Live responses already return it; the old enum was Owner / Member / Invitee only.

Test plan

PM must confirm before merge:

  • Member PUT 200: after assigning a custom role (body is not the previous core role), is role still a core value (Owner / Editor / Member), or is it the custom role name? If it is the custom name, drop the org_member.role enum in a follow-up and describe a string (core or custom name). If it stays a core value, this PR's enum (Owner | Editor | Member | Invitee) is enough.
  • List members: same field. Confirm a user with a custom role lists as a core value vs the custom name.
  • Casing: request stays lowercase (editor); response stays title case (Editor). Confirm that split is real.
  • Team PATCH 200: confirm org_group.role is present and is the value just set (core or custom name).
  • Team assignment is PATCH-only, not PUT.
  • Unknown role names return an error; do not document them as valid.
  • Custom role name (not label or UUID) is the request identifier, matching Docker Home.

akristen and others added 2 commits September 1, 2026 11:51
The public OpenAPI spec listed only core roles for member PUT and omitted team PATCH role, even though the API already accepts custom role names.

Co-authored-by: Cursor <cursoragent@cursor.com>
Live member responses already return Editor; the documented enum only listed Owner, Member, and Invitee.

Co-authored-by: Cursor <cursoragent@cursor.com>
@netlify

netlify Bot commented Sep 1, 2026

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit dcebe28
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a970578e5d6fb000853223f
😎 Deploy Preview https://deploy-preview-25996--docsdocker.netlify.app/reference/api/hub/latest/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added the area/api Relates to Docker API docs label Sep 1, 2026
@akristen akristen added the status/review Pull requests that are ready for review label Sep 1, 2026
@akristen
akristen requested review from a team and gmondello and removed request for a team September 1, 2026 17:04
@akristen
akristen marked this pull request as ready for review September 1, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/api Relates to Docker API docs status/review Pull requests that are ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant