workos-office / docs /11_Workspace_Service /api-ownership.json
dellweb3's picture
Work OS validated demo local-v0.8
99caad5 verified
Raw History Blame Contribute Delete
5.35 kB
{
"source": "docs/10_API_Gateway/api-catalog.json",
"operations": [
{
"operation_id": "listWorkspaces",
"method": "GET",
"path": "/api/v1/workspaces",
"summary": "列出本人的事项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "WorkspacePage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "createWorkspace",
"method": "POST",
"path": "/api/v1/workspaces",
"summary": "建立个人事项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "WorkspaceCreate",
"response_schema": "Workspace",
"status": 201,
"idempotency_required": true
},
{
"operation_id": "getWorkspace",
"method": "GET",
"path": "/api/v1/workspaces/{workspace_id}",
"summary": "进入事项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "Workspace",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "renameWorkspace",
"method": "PATCH",
"path": "/api/v1/workspaces/{workspace_id}",
"summary": "按版本重命名事项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "WorkspacePatch",
"response_schema": "Workspace",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "listMessages",
"method": "GET",
"path": "/api/v1/workspaces/{workspace_id}/messages",
"summary": "读取对话历史",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "MessagePage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "createMessage",
"method": "POST",
"path": "/api/v1/workspaces/{workspace_id}/messages",
"summary": "追加用户消息",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "MessageCreate",
"response_schema": "Message",
"status": 201,
"idempotency_required": true
},
{
"operation_id": "listAttachments",
"method": "GET",
"path": "/api/v1/workspaces/{workspace_id}/attachments",
"summary": "列出事项附件",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "AttachmentPage",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "uploadAttachment",
"method": "POST",
"path": "/api/v1/workspaces/{workspace_id}/attachments",
"summary": "上传一个附件并安排解析",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "Upload",
"response_schema": "Attachment",
"status": 201,
"idempotency_required": true
},
{
"operation_id": "downloadAttachment",
"method": "GET",
"path": "/api/v1/attachments/{attachment_id}/content",
"summary": "授权下载附件",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "Binary",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "bindWorkspaceSkills",
"method": "PUT",
"path": "/api/v1/workspaces/{workspace_id}/skills",
"summary": "按版本更新事项技能选项",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "WorkspaceSkillsInput",
"response_schema": "WorkspaceSkills",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "getArtifact",
"method": "GET",
"path": "/api/v1/artifacts/{artifact_id}",
"summary": "读取本人草稿当前版本",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "Artifact",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "editArtifact",
"method": "PATCH",
"path": "/api/v1/artifacts/{artifact_id}",
"summary": "乐观锁修改草稿",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:write",
"request_schema": "ArtifactPatch",
"response_schema": "Artifact",
"status": 200,
"idempotency_required": false
},
{
"operation_id": "downloadArtifact",
"method": "GET",
"path": "/api/v1/artifacts/{artifact_id}/versions/{version}/content",
"summary": "下载已生成的版本文件",
"owner": "Workspace",
"phase": "PC",
"scope": "workspace:read",
"request_schema": null,
"response_schema": "Binary",
"status": 200,
"idempotency_required": false
}
],
"owner": "Workspace",
"operation_count": 13
}