mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
chore: add request body to patch groups openapi spec (#9101)
This commit is contained in:
Generated
+18
-3
@@ -279,17 +279,32 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
|
||||
```shell
|
||||
# Example request using curl
|
||||
curl -X PATCH http://coder-server:8080/api/v2/groups/{group} \
|
||||
-H 'Content-Type: application/json' \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Coder-Session-Token: API_KEY'
|
||||
```
|
||||
|
||||
`PATCH /groups/{group}`
|
||||
|
||||
> Body parameter
|
||||
|
||||
```json
|
||||
{
|
||||
"add_users": ["string"],
|
||||
"avatar_url": "string",
|
||||
"display_name": "string",
|
||||
"name": "string",
|
||||
"quota_allowance": 0,
|
||||
"remove_users": ["string"]
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| ------- | ---- | ------ | -------- | ----------- |
|
||||
| `group` | path | string | true | Group name |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ------- | ---- | ------------------------------------------------------------------ | -------- | ------------------- |
|
||||
| `group` | path | string | true | Group name |
|
||||
| `body` | body | [codersdk.PatchGroupRequest](schemas.md#codersdkpatchgrouprequest) | true | Patch group request |
|
||||
|
||||
### Example responses
|
||||
|
||||
|
||||
Generated
+24
@@ -3459,6 +3459,30 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| `updated_at` | string | false | | |
|
||||
| `user_id` | string | false | | |
|
||||
|
||||
## codersdk.PatchGroupRequest
|
||||
|
||||
```json
|
||||
{
|
||||
"add_users": ["string"],
|
||||
"avatar_url": "string",
|
||||
"display_name": "string",
|
||||
"name": "string",
|
||||
"quota_allowance": 0,
|
||||
"remove_users": ["string"]
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ----------------- | --------------- | -------- | ------------ | ----------- |
|
||||
| `add_users` | array of string | false | | |
|
||||
| `avatar_url` | string | false | | |
|
||||
| `display_name` | string | false | | |
|
||||
| `name` | string | false | | |
|
||||
| `quota_allowance` | integer | false | | |
|
||||
| `remove_users` | array of string | false | | |
|
||||
|
||||
## codersdk.PatchTemplateVersionRequest
|
||||
|
||||
```json
|
||||
|
||||
Reference in New Issue
Block a user