docs: update template acl example params (#8320)

Param examples were unhelpful
This commit is contained in:
Steven Masley
2023-07-05 13:24:21 -04:00
committed by GitHub
parent 4a008a8f34
commit 418c9b8743
5 changed files with 39 additions and 16 deletions

10
coderd/apidoc/docs.go generated
View File

@ -9377,15 +9377,25 @@ const docTemplate = `{
"type": "object",
"properties": {
"group_perms": {
"description": "GroupPerms should be a mapping of group id to role.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/codersdk.TemplateRole"
},
"example": {
"8bd26b20-f3e8-48be-a903-46bb920cf671": "use",
"\u003cuser_id\u003e\u003e": "admin"
}
},
"user_perms": {
"description": "UserPerms should be a mapping of user id to role. The user id must be the\nuuid of the user, not a username or email address.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/codersdk.TemplateRole"
},
"example": {
"4df59e74-c027-470b-ab4d-cbba8963a5e9": "use",
"\u003cgroup_id\u003e": "admin"
}
}
}