mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
chore: fix some small groups and acl typos (#18732)
- Add `format:"uri"` to `Group.AvatarURL` (matches `User.AvatarURL` field) - `<user_id>` and `<group_id>` were backwards in the `example:` tags - The `@Success` annotation for `/acl [get]` had an incorrect type
This commit is contained in:
ケイラ
GitHub
85
coderd/apidoc/docs.go
generated
85
coderd/apidoc/docs.go
generated
@ -5211,10 +5211,7 @@ const docTemplate = `{
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.TemplateUser"
|
||||
}
|
||||
"$ref": "#/definitions/codersdk.TemplateACL"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -12868,7 +12865,8 @@ const docTemplate = `{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avatar_url": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
},
|
||||
"display_name": {
|
||||
"type": "string"
|
||||
@ -16011,6 +16009,23 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.TemplateACL": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"group": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.TemplateGroup"
|
||||
}
|
||||
},
|
||||
"users": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.TemplateUser"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.TemplateAppUsage": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -16143,6 +16158,62 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.TemplateGroup": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avatar_url": {
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
},
|
||||
"display_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"members": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.ReducedUser"
|
||||
}
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"organization_display_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"organization_id": {
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"organization_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"quota_allowance": {
|
||||
"type": "integer"
|
||||
},
|
||||
"role": {
|
||||
"enum": [
|
||||
"admin",
|
||||
"use"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.TemplateRole"
|
||||
}
|
||||
]
|
||||
},
|
||||
"source": {
|
||||
"$ref": "#/definitions/codersdk.GroupSource"
|
||||
},
|
||||
"total_member_count": {
|
||||
"description": "How many members are in this group. Shows the total count,\neven if the user is not authorized to read group member details.\nMay be greater than ` + "`" + `len(Group.Members)` + "`" + `.",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.TemplateInsightsIntervalReport": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -16764,7 +16835,7 @@ const docTemplate = `{
|
||||
},
|
||||
"example": {
|
||||
"8bd26b20-f3e8-48be-a903-46bb920cf671": "use",
|
||||
"\u003cuser_id\u003e\u003e": "admin"
|
||||
"\u003cgroup_id\u003e": "admin"
|
||||
}
|
||||
},
|
||||
"user_perms": {
|
||||
@ -16775,7 +16846,7 @@ const docTemplate = `{
|
||||
},
|
||||
"example": {
|
||||
"4df59e74-c027-470b-ab4d-cbba8963a5e9": "use",
|
||||
"\u003cgroup_id\u003e": "admin"
|
||||
"\u003cuser_id\u003e": "admin"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
82
coderd/apidoc/swagger.json
generated
82
coderd/apidoc/swagger.json
generated
@ -4590,10 +4590,7 @@
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.TemplateUser"
|
||||
}
|
||||
"$ref": "#/definitions/codersdk.TemplateACL"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -11549,7 +11546,8 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avatar_url": {
|
||||
"type": "string"
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
},
|
||||
"display_name": {
|
||||
"type": "string"
|
||||
@ -14575,6 +14573,23 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.TemplateACL": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"group": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.TemplateGroup"
|
||||
}
|
||||
},
|
||||
"users": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.TemplateUser"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.TemplateAppUsage": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -14701,6 +14716,59 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.TemplateGroup": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"avatar_url": {
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
},
|
||||
"display_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"members": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/codersdk.ReducedUser"
|
||||
}
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"organization_display_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"organization_id": {
|
||||
"type": "string",
|
||||
"format": "uuid"
|
||||
},
|
||||
"organization_name": {
|
||||
"type": "string"
|
||||
},
|
||||
"quota_allowance": {
|
||||
"type": "integer"
|
||||
},
|
||||
"role": {
|
||||
"enum": ["admin", "use"],
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/codersdk.TemplateRole"
|
||||
}
|
||||
]
|
||||
},
|
||||
"source": {
|
||||
"$ref": "#/definitions/codersdk.GroupSource"
|
||||
},
|
||||
"total_member_count": {
|
||||
"description": "How many members are in this group. Shows the total count,\neven if the user is not authorized to read group member details.\nMay be greater than `len(Group.Members)`.",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"codersdk.TemplateInsightsIntervalReport": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -15287,7 +15355,7 @@
|
||||
},
|
||||
"example": {
|
||||
"8bd26b20-f3e8-48be-a903-46bb920cf671": "use",
|
||||
"\u003cuser_id\u003e\u003e": "admin"
|
||||
"\u003cgroup_id\u003e": "admin"
|
||||
}
|
||||
},
|
||||
"user_perms": {
|
||||
@ -15298,7 +15366,7 @@
|
||||
},
|
||||
"example": {
|
||||
"4df59e74-c027-470b-ab4d-cbba8963a5e9": "use",
|
||||
"\u003cgroup_id\u003e": "admin"
|
||||
"\u003cuser_id\u003e": "admin"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user