更新工作区
OpenAPI 契约
- 方法
- PATCH
- 路径
/api/v1/workspaces/{id}- 认证
- jwtBearer (bearer)
- 响应状态
- 200 400 401 403 404 409 429 500
请求与响应 Schema
JSON
{
"requestBody": {
"application/json": {
"$ref": "#/components/schemas/UpdateWorkspaceRequest"
}
},
"responses": {
"200": {
"description": "Workspace updated",
"content": {
"application/json": {
"$ref": "#/components/schemas/WorkspaceResponse"
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"$ref": "#/components/schemas/RequestError"
}
}
},
"401": {
"description": "Authentication required or invalid",
"content": {
"application/json": {
"$ref": "#/components/schemas/SecurityError"
}
}
},
"403": {
"description": "Authenticated but not permitted",
"content": {
"application/json": {
"$ref": "#/components/schemas/SecurityError"
}
}
},
"404": {
"description": "Requested workspace resource was not found",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"409": {
"description": "Request conflicts with current workspace state",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"429": {
"description": "Rate limit exceeded",
"content": {
"application/json": {
"$ref": "#/components/schemas/SecurityError"
}
}
},
"500": {
"description": "Unexpected server error",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}PATCH /api/v1/workspaces/{id} 仅限 JWT,并且需要 workspace:manage。提交非空且最多 100 个字符的 name。服务裁剪名称并返回更新后的工作区响应。
同一组织内的其他工作区不能已使用忽略大小写后相同的名称。重复名称返回冲突;不可访问的工作区不会被暴露。此操作只重命名工作区,不会把它移动到其他组织。
json
{"name":"Production releases"}