6868 lines · 188 KBapplication/json
The Coline App SDK: apps, tools, file types and surfaces that run inside Coline workspaces, and public websites with Coline Sites. TypeScript, with an in-memory test workspace. MIT.
| 7 | "description": "Canonical OpenAPI source for the current stable app-platform slice. This document covers the public store catalog plus the `/api/v1` workspace install/runtime surface." |
| 8 | }, |
| 9 | "servers": [ |
| 10 | { |
| 11 | "url": "https://coline.app", |
| 12 | "description": "Production" |
| 13 | }, |
| 14 | { |
| 15 | "url": "http://localhost:3000", |
| 16 | "description": "Local development" |
| 17 | } |
| 18 | ], |
| 19 | "tags": [ |
| 20 | { |
| 21 | "name": "Store", |
| 22 | "description": "Public store catalog and approved app releases." |
| 23 | }, |
| 24 | { |
| 25 | "name": "Publisher", |
| 26 | "description": "Authenticated app registration and version creation APIs." |
| 27 | }, |
| 28 | { |
| 29 | "name": "Auth", |
| 30 | "description": "Login with Coline OAuth endpoints." |
| 31 | }, |
| 32 | { |
| 33 | "name": "AI", |
| 34 | "description": "Tab API endpoints for completions and model discovery." |
| 35 | }, |
| 36 | { |
| 37 | "name": "Workspace installs", |
| 38 | "description": "Workspace app install and permission APIs." |
| 39 | }, |
| 40 | { |
| 41 | "name": "Runtime", |
| 42 | "description": "Installed app file, index, notification, and ambient APIs." |
| 43 | }, |
| 44 | { |
| 45 | "name": "Members", |
| 46 | "description": "Workspace member listing." |
| 47 | }, |
| 48 | { |
| 49 | "name": "Docs", |
| 50 | "description": "Workspace document CRUD with page layout." |
| 51 | }, |
| 52 | { |
| 53 | "name": "Drives", |
| 54 | "description": "Workspace drive listing." |
| 55 | }, |
| 56 | { |
| 57 | "name": "Files", |
| 58 | "description": "File metadata, update, and deletion." |
| 59 | }, |
| 60 | { |
| 61 | "name": "Notes", |
| 62 | "description": "Workspace note CRUD." |
| 63 | }, |
| 64 | { |
| 65 | "name": "Calendar", |
| 66 | "description": "Calendar event CRUD." |
| 67 | }, |
| 68 | { |
| 69 | "name": "Search", |
| 70 | "description": "Workspace content search." |
| 71 | }, |
| 72 | { |
| 73 | "name": "Tasks", |
| 74 | "description": "Taskboard and task CRUD." |
| 75 | }, |
| 76 | { |
| 77 | "name": "Channels", |
| 78 | "description": "Workspace channel listing and message reading." |
| 79 | }, |
| 80 | { |
| 81 | "name": "Direct Messages", |
| 82 | "description": "Workspace DM listing and message reading." |
| 83 | }, |
| 84 | { |
| 85 | "name": "Messages", |
| 86 | "description": "Message detail, editing, deletion, threads, reactions, and pins." |
| 87 | } |
| 88 | ], |
| 89 | "paths": { |
| 90 | "/api/v1/tab/models": { |
| 91 | "get": { |
| 92 | "tags": [ |
| 93 | "AI" |
| 94 | ], |
| 95 | "summary": "List Tab models", |
| 96 | "operationId": "listTabModels", |
| 97 | "responses": { |
| 98 | "200": { |
| 99 | "description": "Tab model list", |
| 100 | "content": { |
| 101 | "application/json": { |
| 102 | "schema": { |
| 103 | "$ref": "#/components/schemas/TabModelsResponse" |
| 104 | } |
| 105 | } |
| 106 | } |
| 107 | } |
| 108 | } |
| 109 | } |
| 110 | }, |
| 111 | "/api/v1/tab/chat/completions": { |
| 112 | "post": { |
| 113 | "tags": [ |
| 114 | "AI" |
| 115 | ], |
| 116 | "summary": "Create an OpenAI-compatible Tab chat completion", |
| 117 | "operationId": "createTabChatCompletion", |
| 118 | "security": [ |
| 119 | { |
| 120 | "bearerAuth": [] |
| 121 | } |
| 122 | ], |
| 123 | "requestBody": { |
| 124 | "required": true, |
| 125 | "content": { |
| 126 | "application/json": { |
| 127 | "schema": { |
| 128 | "$ref": "#/components/schemas/TabChatCompletionInput" |
| 129 | } |
| 130 | } |
| 131 | } |
| 132 | }, |
| 133 | "responses": { |
| 134 | "200": { |
| 135 | "description": "OpenAI-compatible Tab chat completion", |
| 136 | "content": { |
| 137 | "application/json": { |
| 138 | "schema": { |
| 139 | "$ref": "#/components/schemas/TabChatCompletionResponseEnvelope" |
| 140 | } |
| 141 | } |
| 142 | } |
| 143 | }, |
| 144 | "400": { |
| 145 | "description": "Validation or model error", |
| 146 | "content": { |
| 147 | "application/json": { |
| 148 | "schema": { |
| 149 | "$ref": "#/components/schemas/ErrorEnvelope" |
| 150 | } |
| 151 | } |
| 152 | } |
| 153 | }, |
| 154 | "402": { |
| 155 | "description": "Insufficient credits", |
| 156 | "content": { |
| 157 | "application/json": { |
| 158 | "schema": { |
| 159 | "$ref": "#/components/schemas/ErrorEnvelope" |
| 160 | } |
| 161 | } |
| 162 | } |
| 163 | } |
| 164 | } |
| 165 | } |
| 166 | }, |
| 167 | "/api/v1/oauth/authorize": { |
| 168 | "get": { |
| 169 | "tags": [ |
| 170 | "Auth" |
| 171 | ], |
| 172 | "summary": "Authorize an OAuth client", |
| 173 | "operationId": "authorizeOauthClient", |
| 174 | "parameters": [ |
| 175 | { |
| 176 | "name": "response_type", |
| 177 | "in": "query", |
| 178 | "required": true, |
| 179 | "schema": { |
| 180 | "type": "string", |
| 181 | "const": "code" |
| 182 | } |
| 183 | }, |
| 184 | { |
| 185 | "name": "client_id", |
| 186 | "in": "query", |
| 187 | "required": true, |
| 188 | "schema": { |
| 189 | "type": "string" |
| 190 | } |
| 191 | }, |
| 192 | { |
| 193 | "name": "redirect_uri", |
| 194 | "in": "query", |
| 195 | "required": true, |
| 196 | "schema": { |
| 197 | "type": "string", |
| 198 | "format": "uri" |
| 199 | } |
| 200 | }, |
| 201 | { |
| 202 | "name": "scope", |
| 203 | "in": "query", |
| 204 | "required": false, |
| 205 | "schema": { |
| 206 | "type": "string" |
| 207 | } |
| 208 | }, |
| 209 | { |
| 210 | "name": "state", |
| 211 | "in": "query", |
| 212 | "required": false, |
| 213 | "schema": { |
| 214 | "type": "string" |
| 215 | } |
| 216 | }, |
| 217 | { |
| 218 | "name": "code_challenge", |
| 219 | "in": "query", |
| 220 | "required": false, |
| 221 | "schema": { |
| 222 | "type": "string" |
| 223 | } |
| 224 | }, |
| 225 | { |
| 226 | "name": "code_challenge_method", |
| 227 | "in": "query", |
| 228 | "required": false, |
| 229 | "schema": { |
| 230 | "type": "string" |
| 231 | } |
| 232 | } |
| 233 | ], |
| 234 | "responses": { |
| 235 | "302": { |
| 236 | "description": "Redirect to sign-in or back to the client redirect URI" |
| 237 | }, |
| 238 | "400": { |
| 239 | "description": "Invalid authorization request", |
| 240 | "content": { |
| 241 | "application/json": { |
| 242 | "schema": { |
| 243 | "$ref": "#/components/schemas/ErrorEnvelope" |
| 244 | } |
| 245 | } |
| 246 | } |
| 247 | } |
| 248 | } |
| 249 | } |
| 250 | }, |
| 251 | "/api/v1/oauth/token": { |
| 252 | "post": { |
| 253 | "tags": [ |
| 254 | "Auth" |
| 255 | ], |
| 256 | "summary": "Exchange an authorization code for tokens", |
| 257 | "operationId": "exchangeOauthAuthorizationCode", |
| 258 | "requestBody": { |
| 259 | "required": true, |
| 260 | "content": { |
| 261 | "application/json": { |
| 262 | "schema": { |
| 263 | "$ref": "#/components/schemas/OAuthTokenExchangeInput" |
| 264 | } |
| 265 | }, |
| 266 | "application/x-www-form-urlencoded": { |
| 267 | "schema": { |
| 268 | "$ref": "#/components/schemas/OAuthTokenExchangeInput" |
| 269 | } |
| 270 | } |
| 271 | } |
| 272 | }, |
| 273 | "responses": { |
| 274 | "200": { |
| 275 | "description": "Token response", |
| 276 | "content": { |
| 277 | "application/json": { |
| 278 | "schema": { |
| 279 | "$ref": "#/components/schemas/OAuthTokenResponse" |
| 280 | } |
| 281 | } |
| 282 | } |
| 283 | }, |
| 284 | "400": { |
| 285 | "description": "Invalid token request", |
| 286 | "content": { |
| 287 | "application/json": { |
| 288 | "schema": { |
| 289 | "$ref": "#/components/schemas/OAuthErrorResponse" |
| 290 | } |
| 291 | } |
| 292 | } |
| 293 | } |
| 294 | } |
| 295 | } |
| 296 | }, |
| 297 | "/api/v1/oauth/userinfo": { |
| 298 | "get": { |
| 299 | "tags": [ |
| 300 | "Auth" |
| 301 | ], |
| 302 | "summary": "Resolve OAuth userinfo", |
| 303 | "operationId": "getOauthUserInfo", |
| 304 | "security": [ |
| 305 | { |
| 306 | "bearerAuth": [] |
| 307 | } |
| 308 | ], |
| 309 | "responses": { |
| 310 | "200": { |
| 311 | "description": "User info", |
| 312 | "content": { |
| 313 | "application/json": { |
| 314 | "schema": { |
| 315 | "$ref": "#/components/schemas/OAuthUserInfoResponse" |
| 316 | } |
| 317 | } |
| 318 | } |
| 319 | }, |
| 320 | "401": { |
| 321 | "description": "Invalid token", |
| 322 | "content": { |
| 323 | "application/json": { |
| 324 | "schema": { |
| 325 | "$ref": "#/components/schemas/OAuthErrorResponse" |
| 326 | } |
| 327 | } |
| 328 | } |
| 329 | } |
| 330 | } |
| 331 | } |
| 332 | }, |
| 333 | "/api/v1/apps": { |
| 334 | "get": { |
| 335 | "tags": [ |
| 336 | "Store" |
| 337 | ], |
| 338 | "summary": "List store apps", |
| 339 | "operationId": "listStoreApps", |
| 340 | "responses": { |
| 341 | "200": { |
| 342 | "description": "Store apps", |
| 343 | "content": { |
| 344 | "application/json": { |
| 345 | "schema": { |
| 346 | "$ref": "#/components/schemas/StoreAppsResponse" |
| 347 | } |
| 348 | } |
| 349 | } |
| 350 | } |
| 351 | } |
| 352 | }, |
| 353 | "post": { |
| 354 | "tags": [ |
| 355 | "Publisher" |
| 356 | ], |
| 357 | "summary": "Register a new app and initial release", |
| 358 | "operationId": "registerApp", |
| 359 | "security": [ |
| 360 | { |
| 361 | "bearerAuth": [] |
| 362 | } |
| 363 | ], |
| 364 | "requestBody": { |
| 365 | "required": true, |
| 366 | "content": { |
| 367 | "application/json": { |
| 368 | "schema": { |
| 369 | "$ref": "#/components/schemas/RegisterAppInput" |
| 370 | } |
| 371 | } |
| 372 | } |
| 373 | }, |
| 374 | "responses": { |
| 375 | "201": { |
| 376 | "description": "Registered app", |
| 377 | "content": { |
| 378 | "application/json": { |
| 379 | "schema": { |
| 380 | "$ref": "#/components/schemas/AppVersionMutationResponse" |
| 381 | } |
| 382 | } |
| 383 | } |
| 384 | } |
| 385 | } |
| 386 | } |
| 387 | }, |
| 388 | "/api/v1/apps/{appKey}": { |
| 389 | "get": { |
| 390 | "tags": [ |
| 391 | "Store" |
| 392 | ], |
| 393 | "summary": "Get a store app", |
| 394 | "operationId": "getStoreApp", |
| 395 | "parameters": [ |
| 396 | { |
| 397 | "name": "appKey", |
| 398 | "in": "path", |
| 399 | "required": true, |
| 400 | "schema": { |
| 401 | "type": "string" |
| 402 | } |
| 403 | } |
| 404 | ], |
| 405 | "responses": { |
| 406 | "200": { |
| 407 | "description": "Store app detail", |
| 408 | "content": { |
| 409 | "application/json": { |
| 410 | "schema": { |
| 411 | "$ref": "#/components/schemas/StoreAppResponse" |
| 412 | } |
| 413 | } |
| 414 | } |
| 415 | }, |
| 416 | "404": { |
| 417 | "description": "App not found", |
| 418 | "content": { |
| 419 | "application/json": { |
| 420 | "schema": { |
| 421 | "$ref": "#/components/schemas/ErrorEnvelope" |
| 422 | } |
| 423 | } |
| 424 | } |
| 425 | } |
| 426 | } |
| 427 | } |
| 428 | }, |
| 429 | "/api/v1/apps/{appKey}/versions": { |
| 430 | "get": { |
| 431 | "tags": [ |
| 432 | "Store" |
| 433 | ], |
| 434 | "summary": "List approved versions for a store app", |
| 435 | "operationId": "listStoreAppVersions", |
| 436 | "parameters": [ |
| 437 | { |
| 438 | "name": "appKey", |
| 439 | "in": "path", |
| 440 | "required": true, |
| 441 | "schema": { |
| 442 | "type": "string" |
| 443 | } |
| 444 | } |
| 445 | ], |
| 446 | "responses": { |
| 447 | "200": { |
| 448 | "description": "Approved store app versions", |
| 449 | "content": { |
| 450 | "application/json": { |
| 451 | "schema": { |
| 452 | "$ref": "#/components/schemas/StoreAppVersionsResponse" |
| 453 | } |
| 454 | } |
| 455 | } |
| 456 | } |
| 457 | } |
| 458 | }, |
| 459 | "post": { |
| 460 | "tags": [ |
| 461 | "Publisher" |
| 462 | ], |
| 463 | "summary": "Create a new app version", |
| 464 | "operationId": "createAppVersion", |
| 465 | "security": [ |
| 466 | { |
| 467 | "bearerAuth": [] |
| 468 | } |
| 469 | ], |
| 470 | "parameters": [ |
| 471 | { |
| 472 | "name": "appKey", |
| 473 | "in": "path", |
| 474 | "required": true, |
| 475 | "schema": { |
| 476 | "type": "string" |
| 477 | } |
| 478 | } |
| 479 | ], |
| 480 | "requestBody": { |
| 481 | "required": true, |
| 482 | "content": { |
| 483 | "application/json": { |
| 484 | "schema": { |
| 485 | "$ref": "#/components/schemas/RegisterAppInput" |
| 486 | } |
| 487 | } |
| 488 | } |
| 489 | }, |
| 490 | "responses": { |
| 491 | "201": { |
| 492 | "description": "Created app version", |
| 493 | "content": { |
| 494 | "application/json": { |
| 495 | "schema": { |
| 496 | "$ref": "#/components/schemas/AppVersionMutationResponse" |
| 497 | } |
| 498 | } |
| 499 | } |
| 500 | } |
| 501 | } |
| 502 | } |
| 503 | }, |
| 504 | "/api/v1/apps/{appKey}/versions/{versionId}/submit": { |
| 505 | "post": { |
| 506 | "tags": [ |
| 507 | "Publisher" |
| 508 | ], |
| 509 | "summary": "Submit an app version for review", |
| 510 | "operationId": "submitAppVersionForReview", |
| 511 | "security": [ |
| 512 | { |
| 513 | "bearerAuth": [] |
| 514 | } |
| 515 | ], |
| 516 | "parameters": [ |
| 517 | { |
| 518 | "name": "appKey", |
| 519 | "in": "path", |
| 520 | "required": true, |
| 521 | "schema": { |
| 522 | "type": "string" |
| 523 | } |
| 524 | }, |
| 525 | { |
| 526 | "name": "versionId", |
| 527 | "in": "path", |
| 528 | "required": true, |
| 529 | "schema": { |
| 530 | "type": "string" |
| 531 | } |
| 532 | } |
| 533 | ], |
| 534 | "requestBody": { |
| 535 | "required": true, |
| 536 | "content": { |
| 537 | "application/json": { |
| 538 | "schema": { |
| 539 | "type": "object", |
| 540 | "properties": { |
| 541 | "storeListed": { |
| 542 | "type": "boolean" |
| 543 | } |
| 544 | } |
| 545 | } |
| 546 | } |
| 547 | } |
| 548 | }, |
| 549 | "responses": { |
| 550 | "200": { |
| 551 | "description": "Submitted app version", |
| 552 | "content": { |
| 553 | "application/json": { |
| 554 | "schema": { |
| 555 | "$ref": "#/components/schemas/SubmitAppVersionForReviewResponse" |
| 556 | } |
| 557 | } |
| 558 | } |
| 559 | } |
| 560 | } |
| 561 | } |
| 562 | }, |
| 563 | "/api/v1/workspaces/{workspaceSlug}/apps": { |
| 564 | "get": { |
| 565 | "tags": [ |
| 566 | "Workspace installs" |
| 567 | ], |
| 568 | "summary": "List installed apps and workspace-visible catalog", |
| 569 | "operationId": "listWorkspaceApps", |
| 570 | "security": [ |
| 571 | { |
| 572 | "bearerAuth": [] |
| 573 | } |
| 574 | ], |
| 575 | "parameters": [ |
| 576 | { |
| 577 | "name": "workspaceSlug", |
| 578 | "in": "path", |
| 579 | "required": true, |
| 580 | "schema": { |
| 581 | "type": "string" |
| 582 | } |
| 583 | } |
| 584 | ], |
| 585 | "responses": { |
| 586 | "200": { |
| 587 | "description": "Workspace app data", |
| 588 | "content": { |
| 589 | "application/json": { |
| 590 | "schema": { |
| 591 | "$ref": "#/components/schemas/WorkspaceAppsResponse" |
| 592 | } |
| 593 | } |
| 594 | } |
| 595 | } |
| 596 | } |
| 597 | }, |
| 598 | "post": { |
| 599 | "tags": [ |
| 600 | "Workspace installs" |
| 601 | ], |
| 602 | "summary": "Install an app into a workspace", |
| 603 | "operationId": "installWorkspaceApp", |
| 604 | "security": [ |
| 605 | { |
| 606 | "bearerAuth": [] |
| 607 | } |
| 608 | ], |
| 609 | "parameters": [ |
| 610 | { |
| 611 | "name": "workspaceSlug", |
| 612 | "in": "path", |
| 613 | "required": true, |
| 614 | "schema": { |
| 615 | "type": "string" |
| 616 | } |
| 617 | } |
| 618 | ], |
| 619 | "requestBody": { |
| 620 | "required": true, |
| 621 | "content": { |
| 622 | "application/json": { |
| 623 | "schema": { |
| 624 | "$ref": "#/components/schemas/InstallWorkspaceAppInput" |
| 625 | } |
| 626 | } |
| 627 | } |
| 628 | }, |
| 629 | "responses": { |
| 630 | "201": { |
| 631 | "description": "Installed app", |
| 632 | "content": { |
| 633 | "application/json": { |
| 634 | "schema": { |
| 635 | "$ref": "#/components/schemas/InstallWorkspaceAppResponse" |
| 636 | } |
| 637 | } |
| 638 | } |
| 639 | } |
| 640 | } |
| 641 | } |
| 642 | }, |
| 643 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}": { |
| 644 | "get": { |
| 645 | "tags": [ |
| 646 | "Workspace installs" |
| 647 | ], |
| 648 | "summary": "Get an installed workspace app", |
| 649 | "operationId": "getWorkspaceInstalledApp", |
| 650 | "security": [ |
| 651 | { |
| 652 | "bearerAuth": [] |
| 653 | } |
| 654 | ], |
| 655 | "parameters": [ |
| 656 | { |
| 657 | "name": "workspaceSlug", |
| 658 | "in": "path", |
| 659 | "required": true, |
| 660 | "schema": { |
| 661 | "type": "string" |
| 662 | } |
| 663 | }, |
| 664 | { |
| 665 | "name": "appKey", |
| 666 | "in": "path", |
| 667 | "required": true, |
| 668 | "schema": { |
| 669 | "type": "string" |
| 670 | } |
| 671 | } |
| 672 | ], |
| 673 | "responses": { |
| 674 | "200": { |
| 675 | "description": "Installed app", |
| 676 | "content": { |
| 677 | "application/json": { |
| 678 | "schema": { |
| 679 | "$ref": "#/components/schemas/WorkspaceInstalledAppResponse" |
| 680 | } |
| 681 | } |
| 682 | } |
| 683 | } |
| 684 | } |
| 685 | }, |
| 686 | "delete": { |
| 687 | "tags": [ |
| 688 | "Workspace installs" |
| 689 | ], |
| 690 | "summary": "Uninstall a workspace app", |
| 691 | "operationId": "uninstallWorkspaceApp", |
| 692 | "security": [ |
| 693 | { |
| 694 | "bearerAuth": [] |
| 695 | } |
| 696 | ], |
| 697 | "parameters": [ |
| 698 | { |
| 699 | "name": "workspaceSlug", |
| 700 | "in": "path", |
| 701 | "required": true, |
| 702 | "schema": { |
| 703 | "type": "string" |
| 704 | } |
| 705 | }, |
| 706 | { |
| 707 | "name": "appKey", |
| 708 | "in": "path", |
| 709 | "required": true, |
| 710 | "schema": { |
| 711 | "type": "string" |
| 712 | } |
| 713 | } |
| 714 | ], |
| 715 | "responses": { |
| 716 | "200": { |
| 717 | "description": "App uninstalled", |
| 718 | "content": { |
| 719 | "application/json": { |
| 720 | "schema": { |
| 721 | "$ref": "#/components/schemas/OkResponse" |
| 722 | } |
| 723 | } |
| 724 | } |
| 725 | } |
| 726 | } |
| 727 | } |
| 728 | }, |
| 729 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/permissions": { |
| 730 | "get": { |
| 731 | "tags": [ |
| 732 | "Workspace installs" |
| 733 | ], |
| 734 | "summary": "Get granted workspace app permissions", |
| 735 | "operationId": "getWorkspaceAppPermissions", |
| 736 | "security": [ |
| 737 | { |
| 738 | "bearerAuth": [] |
| 739 | } |
| 740 | ], |
| 741 | "parameters": [ |
| 742 | { |
| 743 | "name": "workspaceSlug", |
| 744 | "in": "path", |
| 745 | "required": true, |
| 746 | "schema": { |
| 747 | "type": "string" |
| 748 | } |
| 749 | }, |
| 750 | { |
| 751 | "name": "appKey", |
| 752 | "in": "path", |
| 753 | "required": true, |
| 754 | "schema": { |
| 755 | "type": "string" |
| 756 | } |
| 757 | } |
| 758 | ], |
| 759 | "responses": { |
| 760 | "200": { |
| 761 | "description": "Workspace app permissions", |
| 762 | "content": { |
| 763 | "application/json": { |
| 764 | "schema": { |
| 765 | "$ref": "#/components/schemas/WorkspaceAppPermissionsResponse" |
| 766 | } |
| 767 | } |
| 768 | } |
| 769 | } |
| 770 | } |
| 771 | }, |
| 772 | "put": { |
| 773 | "tags": [ |
| 774 | "Workspace installs" |
| 775 | ], |
| 776 | "summary": "Update granted workspace app permissions", |
| 777 | "operationId": "updateWorkspaceAppPermissions", |
| 778 | "security": [ |
| 779 | { |
| 780 | "bearerAuth": [] |
| 781 | } |
| 782 | ], |
| 783 | "parameters": [ |
| 784 | { |
| 785 | "name": "workspaceSlug", |
| 786 | "in": "path", |
| 787 | "required": true, |
| 788 | "schema": { |
| 789 | "type": "string" |
| 790 | } |
| 791 | }, |
| 792 | { |
| 793 | "name": "appKey", |
| 794 | "in": "path", |
| 795 | "required": true, |
| 796 | "schema": { |
| 797 | "type": "string" |
| 798 | } |
| 799 | } |
| 800 | ], |
| 801 | "requestBody": { |
| 802 | "required": true, |
| 803 | "content": { |
| 804 | "application/json": { |
| 805 | "schema": { |
| 806 | "type": "object", |
| 807 | "required": [ |
| 808 | "grantedPermissions" |
| 809 | ], |
| 810 | "properties": { |
| 811 | "grantedPermissions": { |
| 812 | "type": "array", |
| 813 | "items": { |
| 814 | "type": "string" |
| 815 | } |
| 816 | } |
| 817 | } |
| 818 | } |
| 819 | } |
| 820 | } |
| 821 | }, |
| 822 | "responses": { |
| 823 | "200": { |
| 824 | "description": "Updated permissions", |
| 825 | "content": { |
| 826 | "application/json": { |
| 827 | "schema": { |
| 828 | "$ref": "#/components/schemas/WorkspaceAppPermissionsResponse" |
| 829 | } |
| 830 | } |
| 831 | } |
| 832 | } |
| 833 | } |
| 834 | } |
| 835 | }, |
| 836 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/secrets": { |
| 837 | "get": { |
| 838 | "tags": [ |
| 839 | "Workspace installs" |
| 840 | ], |
| 841 | "summary": "List app secrets", |
| 842 | "operationId": "listWorkspaceAppSecrets", |
| 843 | "security": [ |
| 844 | { |
| 845 | "bearerAuth": [] |
| 846 | } |
| 847 | ], |
| 848 | "parameters": [ |
| 849 | { |
| 850 | "name": "workspaceSlug", |
| 851 | "in": "path", |
| 852 | "required": true, |
| 853 | "schema": { |
| 854 | "type": "string" |
| 855 | } |
| 856 | }, |
| 857 | { |
| 858 | "name": "appKey", |
| 859 | "in": "path", |
| 860 | "required": true, |
| 861 | "schema": { |
| 862 | "type": "string" |
| 863 | } |
| 864 | } |
| 865 | ], |
| 866 | "responses": { |
| 867 | "200": { |
| 868 | "description": "App secrets", |
| 869 | "content": { |
| 870 | "application/json": { |
| 871 | "schema": { |
| 872 | "$ref": "#/components/schemas/WorkspaceAppSecretsResponse" |
| 873 | } |
| 874 | } |
| 875 | } |
| 876 | } |
| 877 | } |
| 878 | }, |
| 879 | "post": { |
| 880 | "tags": [ |
| 881 | "Workspace installs" |
| 882 | ], |
| 883 | "summary": "Create or rotate app secret", |
| 884 | "operationId": "createWorkspaceAppSecret", |
| 885 | "security": [ |
| 886 | { |
| 887 | "bearerAuth": [] |
| 888 | } |
| 889 | ], |
| 890 | "parameters": [ |
| 891 | { |
| 892 | "name": "workspaceSlug", |
| 893 | "in": "path", |
| 894 | "required": true, |
| 895 | "schema": { |
| 896 | "type": "string" |
| 897 | } |
| 898 | }, |
| 899 | { |
| 900 | "name": "appKey", |
| 901 | "in": "path", |
| 902 | "required": true, |
| 903 | "schema": { |
| 904 | "type": "string" |
| 905 | } |
| 906 | } |
| 907 | ], |
| 908 | "requestBody": { |
| 909 | "required": true, |
| 910 | "content": { |
| 911 | "application/json": { |
| 912 | "schema": { |
| 913 | "type": "object", |
| 914 | "required": [ |
| 915 | "key", |
| 916 | "value" |
| 917 | ], |
| 918 | "properties": { |
| 919 | "key": { |
| 920 | "type": "string" |
| 921 | }, |
| 922 | "value": { |
| 923 | "type": "string" |
| 924 | } |
| 925 | } |
| 926 | } |
| 927 | } |
| 928 | } |
| 929 | }, |
| 930 | "responses": { |
| 931 | "201": { |
| 932 | "description": "App secret stored", |
| 933 | "content": { |
| 934 | "application/json": { |
| 935 | "schema": { |
| 936 | "$ref": "#/components/schemas/CreateWorkspaceAppSecretResponse" |
| 937 | } |
| 938 | } |
| 939 | } |
| 940 | } |
| 941 | } |
| 942 | } |
| 943 | }, |
| 944 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/secrets/{secretId}": { |
| 945 | "delete": { |
| 946 | "tags": [ |
| 947 | "Workspace installs" |
| 948 | ], |
| 949 | "summary": "Delete app secret", |
| 950 | "operationId": "deleteWorkspaceAppSecret", |
| 951 | "security": [ |
| 952 | { |
| 953 | "bearerAuth": [] |
| 954 | } |
| 955 | ], |
| 956 | "parameters": [ |
| 957 | { |
| 958 | "name": "workspaceSlug", |
| 959 | "in": "path", |
| 960 | "required": true, |
| 961 | "schema": { |
| 962 | "type": "string" |
| 963 | } |
| 964 | }, |
| 965 | { |
| 966 | "name": "appKey", |
| 967 | "in": "path", |
| 968 | "required": true, |
| 969 | "schema": { |
| 970 | "type": "string" |
| 971 | } |
| 972 | }, |
| 973 | { |
| 974 | "name": "secretId", |
| 975 | "in": "path", |
| 976 | "required": true, |
| 977 | "schema": { |
| 978 | "type": "string" |
| 979 | } |
| 980 | } |
| 981 | ], |
| 982 | "responses": { |
| 983 | "200": { |
| 984 | "description": "App secret deleted", |
| 985 | "content": { |
| 986 | "application/json": { |
| 987 | "schema": { |
| 988 | "$ref": "#/components/schemas/OkResponse" |
| 989 | } |
| 990 | } |
| 991 | } |
| 992 | } |
| 993 | } |
| 994 | } |
| 995 | }, |
| 996 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/oauth-connections": { |
| 997 | "get": { |
| 998 | "tags": [ |
| 999 | "Workspace installs" |
| 1000 | ], |
| 1001 | "summary": "List app OAuth connections", |
| 1002 | "operationId": "listWorkspaceAppOauthConnections", |
| 1003 | "security": [ |
| 1004 | { |
| 1005 | "bearerAuth": [] |
| 1006 | } |
| 1007 | ], |
| 1008 | "parameters": [ |
| 1009 | { |
| 1010 | "name": "workspaceSlug", |
| 1011 | "in": "path", |
| 1012 | "required": true, |
| 1013 | "schema": { |
| 1014 | "type": "string" |
| 1015 | } |
| 1016 | }, |
| 1017 | { |
| 1018 | "name": "appKey", |
| 1019 | "in": "path", |
| 1020 | "required": true, |
| 1021 | "schema": { |
| 1022 | "type": "string" |
| 1023 | } |
| 1024 | } |
| 1025 | ], |
| 1026 | "responses": { |
| 1027 | "200": { |
| 1028 | "description": "App OAuth connections", |
| 1029 | "content": { |
| 1030 | "application/json": { |
| 1031 | "schema": { |
| 1032 | "$ref": "#/components/schemas/WorkspaceAppOauthConnectionsResponse" |
| 1033 | } |
| 1034 | } |
| 1035 | } |
| 1036 | } |
| 1037 | } |
| 1038 | }, |
| 1039 | "post": { |
| 1040 | "tags": [ |
| 1041 | "Workspace installs" |
| 1042 | ], |
| 1043 | "summary": "Create or update app OAuth connection", |
| 1044 | "operationId": "createWorkspaceAppOauthConnection", |
| 1045 | "security": [ |
| 1046 | { |
| 1047 | "bearerAuth": [] |
| 1048 | } |
| 1049 | ], |
| 1050 | "parameters": [ |
| 1051 | { |
| 1052 | "name": "workspaceSlug", |
| 1053 | "in": "path", |
| 1054 | "required": true, |
| 1055 | "schema": { |
| 1056 | "type": "string" |
| 1057 | } |
| 1058 | }, |
| 1059 | { |
| 1060 | "name": "appKey", |
| 1061 | "in": "path", |
| 1062 | "required": true, |
| 1063 | "schema": { |
| 1064 | "type": "string" |
| 1065 | } |
| 1066 | } |
| 1067 | ], |
| 1068 | "requestBody": { |
| 1069 | "required": true, |
| 1070 | "content": { |
| 1071 | "application/json": { |
| 1072 | "schema": { |
| 1073 | "type": "object", |
| 1074 | "required": [ |
| 1075 | "providerKey", |
| 1076 | "accessToken", |
| 1077 | "scopes" |
| 1078 | ], |
| 1079 | "properties": { |
| 1080 | "providerKey": { |
| 1081 | "type": "string" |
| 1082 | }, |
| 1083 | "externalAccountId": { |
| 1084 | "type": "string" |
| 1085 | }, |
| 1086 | "accessToken": { |
| 1087 | "type": "string" |
| 1088 | }, |
| 1089 | "refreshToken": { |
| 1090 | "type": "string" |
| 1091 | }, |
| 1092 | "scopes": { |
| 1093 | "type": "array", |
| 1094 | "items": { |
| 1095 | "type": "string" |
| 1096 | } |
| 1097 | }, |
| 1098 | "tokenExpiresAt": { |
| 1099 | "type": "string", |
| 1100 | "format": "date-time" |
| 1101 | }, |
| 1102 | "metadata": { |
| 1103 | "type": "object", |
| 1104 | "additionalProperties": true |
| 1105 | } |
| 1106 | } |
| 1107 | } |
| 1108 | } |
| 1109 | } |
| 1110 | }, |
| 1111 | "responses": { |
| 1112 | "201": { |
| 1113 | "description": "App OAuth connection stored", |
| 1114 | "content": { |
| 1115 | "application/json": { |
| 1116 | "schema": { |
| 1117 | "$ref": "#/components/schemas/CreateWorkspaceAppOauthConnectionResponse" |
| 1118 | } |
| 1119 | } |
| 1120 | } |
| 1121 | } |
| 1122 | } |
| 1123 | } |
| 1124 | }, |
| 1125 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/oauth-connections/{connectionId}": { |
| 1126 | "delete": { |
| 1127 | "tags": [ |
| 1128 | "Workspace installs" |
| 1129 | ], |
| 1130 | "summary": "Delete app OAuth connection", |
| 1131 | "operationId": "deleteWorkspaceAppOauthConnection", |
| 1132 | "security": [ |
| 1133 | { |
| 1134 | "bearerAuth": [] |
| 1135 | } |
| 1136 | ], |
| 1137 | "parameters": [ |
| 1138 | { |
| 1139 | "name": "workspaceSlug", |
| 1140 | "in": "path", |
| 1141 | "required": true, |
| 1142 | "schema": { |
| 1143 | "type": "string" |
| 1144 | } |
| 1145 | }, |
| 1146 | { |
| 1147 | "name": "appKey", |
| 1148 | "in": "path", |
| 1149 | "required": true, |
| 1150 | "schema": { |
| 1151 | "type": "string" |
| 1152 | } |
| 1153 | }, |
| 1154 | { |
| 1155 | "name": "connectionId", |
| 1156 | "in": "path", |
| 1157 | "required": true, |
| 1158 | "schema": { |
| 1159 | "type": "string" |
| 1160 | } |
| 1161 | } |
| 1162 | ], |
| 1163 | "responses": { |
| 1164 | "200": { |
| 1165 | "description": "App OAuth connection deleted", |
| 1166 | "content": { |
| 1167 | "application/json": { |
| 1168 | "schema": { |
| 1169 | "$ref": "#/components/schemas/OkResponse" |
| 1170 | } |
| 1171 | } |
| 1172 | } |
| 1173 | } |
| 1174 | } |
| 1175 | } |
| 1176 | }, |
| 1177 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/deliveries": { |
| 1178 | "get": { |
| 1179 | "tags": [ |
| 1180 | "Workspace installs" |
| 1181 | ], |
| 1182 | "summary": "List app deliveries", |
| 1183 | "operationId": "listWorkspaceAppDeliveries", |
| 1184 | "security": [ |
| 1185 | { |
| 1186 | "bearerAuth": [] |
| 1187 | } |
| 1188 | ], |
| 1189 | "parameters": [ |
| 1190 | { |
| 1191 | "name": "workspaceSlug", |
| 1192 | "in": "path", |
| 1193 | "required": true, |
| 1194 | "schema": { |
| 1195 | "type": "string" |
| 1196 | } |
| 1197 | }, |
| 1198 | { |
| 1199 | "name": "appKey", |
| 1200 | "in": "path", |
| 1201 | "required": true, |
| 1202 | "schema": { |
| 1203 | "type": "string" |
| 1204 | } |
| 1205 | } |
| 1206 | ], |
| 1207 | "responses": { |
| 1208 | "200": { |
| 1209 | "description": "App deliveries", |
| 1210 | "content": { |
| 1211 | "application/json": { |
| 1212 | "schema": { |
| 1213 | "$ref": "#/components/schemas/WorkspaceAppDeliveriesResponse" |
| 1214 | } |
| 1215 | } |
| 1216 | } |
| 1217 | } |
| 1218 | } |
| 1219 | }, |
| 1220 | "post": { |
| 1221 | "tags": [ |
| 1222 | "Workspace installs" |
| 1223 | ], |
| 1224 | "summary": "Send a signed test delivery", |
| 1225 | "operationId": "sendWorkspaceAppTestDelivery", |
| 1226 | "security": [ |
| 1227 | { |
| 1228 | "bearerAuth": [] |
| 1229 | } |
| 1230 | ], |
| 1231 | "parameters": [ |
| 1232 | { |
| 1233 | "name": "workspaceSlug", |
| 1234 | "in": "path", |
| 1235 | "required": true, |
| 1236 | "schema": { |
| 1237 | "type": "string" |
| 1238 | } |
| 1239 | }, |
| 1240 | { |
| 1241 | "name": "appKey", |
| 1242 | "in": "path", |
| 1243 | "required": true, |
| 1244 | "schema": { |
| 1245 | "type": "string" |
| 1246 | } |
| 1247 | } |
| 1248 | ], |
| 1249 | "requestBody": { |
| 1250 | "required": true, |
| 1251 | "content": { |
| 1252 | "application/json": { |
| 1253 | "schema": { |
| 1254 | "type": "object", |
| 1255 | "required": [ |
| 1256 | "eventType", |
| 1257 | "payload" |
| 1258 | ], |
| 1259 | "properties": { |
| 1260 | "eventType": { |
| 1261 | "type": "string" |
| 1262 | }, |
| 1263 | "targetUrl": { |
| 1264 | "type": "string" |
| 1265 | }, |
| 1266 | "payload": { |
| 1267 | "type": "object", |
| 1268 | "additionalProperties": true |
| 1269 | } |
| 1270 | } |
| 1271 | } |
| 1272 | } |
| 1273 | } |
| 1274 | }, |
| 1275 | "responses": { |
| 1276 | "201": { |
| 1277 | "description": "Test delivery recorded", |
| 1278 | "content": { |
| 1279 | "application/json": { |
| 1280 | "schema": { |
| 1281 | "$ref": "#/components/schemas/SendWorkspaceAppTestDeliveryResponse" |
| 1282 | } |
| 1283 | } |
| 1284 | } |
| 1285 | } |
| 1286 | } |
| 1287 | } |
| 1288 | }, |
| 1289 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/deliveries/{deliveryId}/replay": { |
| 1290 | "post": { |
| 1291 | "tags": [ |
| 1292 | "Workspace installs" |
| 1293 | ], |
| 1294 | "summary": "Replay a stored app delivery", |
| 1295 | "operationId": "replayWorkspaceAppDelivery", |
| 1296 | "security": [ |
| 1297 | { |
| 1298 | "bearerAuth": [] |
| 1299 | } |
| 1300 | ], |
| 1301 | "parameters": [ |
| 1302 | { |
| 1303 | "name": "workspaceSlug", |
| 1304 | "in": "path", |
| 1305 | "required": true, |
| 1306 | "schema": { |
| 1307 | "type": "string" |
| 1308 | } |
| 1309 | }, |
| 1310 | { |
| 1311 | "name": "appKey", |
| 1312 | "in": "path", |
| 1313 | "required": true, |
| 1314 | "schema": { |
| 1315 | "type": "string" |
| 1316 | } |
| 1317 | }, |
| 1318 | { |
| 1319 | "name": "deliveryId", |
| 1320 | "in": "path", |
| 1321 | "required": true, |
| 1322 | "schema": { |
| 1323 | "type": "string" |
| 1324 | } |
| 1325 | } |
| 1326 | ], |
| 1327 | "responses": { |
| 1328 | "200": { |
| 1329 | "description": "Delivery replayed", |
| 1330 | "content": { |
| 1331 | "application/json": { |
| 1332 | "schema": { |
| 1333 | "$ref": "#/components/schemas/SendWorkspaceAppTestDeliveryResponse" |
| 1334 | } |
| 1335 | } |
| 1336 | } |
| 1337 | } |
| 1338 | } |
| 1339 | } |
| 1340 | }, |
| 1341 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/files/{fileId}": { |
| 1342 | "get": { |
| 1343 | "tags": [ |
| 1344 | "Runtime" |
| 1345 | ], |
| 1346 | "summary": "Read an app-backed file document", |
| 1347 | "operationId": "getAppFileDocument", |
| 1348 | "security": [ |
| 1349 | { |
| 1350 | "bearerAuth": [] |
| 1351 | } |
| 1352 | ], |
| 1353 | "parameters": [ |
| 1354 | { |
| 1355 | "name": "workspaceSlug", |
| 1356 | "in": "path", |
| 1357 | "required": true, |
| 1358 | "schema": { |
| 1359 | "type": "string" |
| 1360 | } |
| 1361 | }, |
| 1362 | { |
| 1363 | "name": "appKey", |
| 1364 | "in": "path", |
| 1365 | "required": true, |
| 1366 | "schema": { |
| 1367 | "type": "string" |
| 1368 | } |
| 1369 | }, |
| 1370 | { |
| 1371 | "name": "fileId", |
| 1372 | "in": "path", |
| 1373 | "required": true, |
| 1374 | "schema": { |
| 1375 | "type": "string" |
| 1376 | } |
| 1377 | } |
| 1378 | ], |
| 1379 | "responses": { |
| 1380 | "200": { |
| 1381 | "description": "App-backed file document", |
| 1382 | "content": { |
| 1383 | "application/json": { |
| 1384 | "schema": { |
| 1385 | "$ref": "#/components/schemas/AppFileDocumentResponse" |
| 1386 | } |
| 1387 | } |
| 1388 | } |
| 1389 | } |
| 1390 | } |
| 1391 | }, |
| 1392 | "patch": { |
| 1393 | "tags": [ |
| 1394 | "Runtime" |
| 1395 | ], |
| 1396 | "summary": "Update an app-backed file document", |
| 1397 | "operationId": "updateAppFileDocument", |
| 1398 | "security": [ |
| 1399 | { |
| 1400 | "bearerAuth": [] |
| 1401 | } |
| 1402 | ], |
| 1403 | "parameters": [ |
| 1404 | { |
| 1405 | "name": "workspaceSlug", |
| 1406 | "in": "path", |
| 1407 | "required": true, |
| 1408 | "schema": { |
| 1409 | "type": "string" |
| 1410 | } |
| 1411 | }, |
| 1412 | { |
| 1413 | "name": "appKey", |
| 1414 | "in": "path", |
| 1415 | "required": true, |
| 1416 | "schema": { |
| 1417 | "type": "string" |
| 1418 | } |
| 1419 | }, |
| 1420 | { |
| 1421 | "name": "fileId", |
| 1422 | "in": "path", |
| 1423 | "required": true, |
| 1424 | "schema": { |
| 1425 | "type": "string" |
| 1426 | } |
| 1427 | } |
| 1428 | ], |
| 1429 | "requestBody": { |
| 1430 | "required": true, |
| 1431 | "content": { |
| 1432 | "application/json": { |
| 1433 | "schema": { |
| 1434 | "type": "object", |
| 1435 | "required": [ |
| 1436 | "document" |
| 1437 | ], |
| 1438 | "properties": { |
| 1439 | "document": { |
| 1440 | "type": "object", |
| 1441 | "additionalProperties": true |
| 1442 | } |
| 1443 | } |
| 1444 | } |
| 1445 | } |
| 1446 | } |
| 1447 | }, |
| 1448 | "responses": { |
| 1449 | "200": { |
| 1450 | "description": "Updated app-backed file document", |
| 1451 | "content": { |
| 1452 | "application/json": { |
| 1453 | "schema": { |
| 1454 | "$ref": "#/components/schemas/AppFileDocumentUpdateResponse" |
| 1455 | } |
| 1456 | } |
| 1457 | } |
| 1458 | } |
| 1459 | } |
| 1460 | } |
| 1461 | }, |
| 1462 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/files": { |
| 1463 | "get": { |
| 1464 | "tags": [ |
| 1465 | "Runtime" |
| 1466 | ], |
| 1467 | "summary": "List app-backed files", |
| 1468 | "operationId": "listAppFiles", |
| 1469 | "security": [ |
| 1470 | { |
| 1471 | "bearerAuth": [] |
| 1472 | } |
| 1473 | ], |
| 1474 | "parameters": [ |
| 1475 | { |
| 1476 | "name": "workspaceSlug", |
| 1477 | "in": "path", |
| 1478 | "required": true, |
| 1479 | "schema": { |
| 1480 | "type": "string" |
| 1481 | } |
| 1482 | }, |
| 1483 | { |
| 1484 | "name": "appKey", |
| 1485 | "in": "path", |
| 1486 | "required": true, |
| 1487 | "schema": { |
| 1488 | "type": "string" |
| 1489 | } |
| 1490 | }, |
| 1491 | { |
| 1492 | "name": "driveId", |
| 1493 | "in": "query", |
| 1494 | "required": false, |
| 1495 | "schema": { |
| 1496 | "type": "string" |
| 1497 | } |
| 1498 | }, |
| 1499 | { |
| 1500 | "name": "typeKey", |
| 1501 | "in": "query", |
| 1502 | "required": false, |
| 1503 | "schema": { |
| 1504 | "type": "string" |
| 1505 | } |
| 1506 | }, |
| 1507 | { |
| 1508 | "name": "limit", |
| 1509 | "in": "query", |
| 1510 | "required": false, |
| 1511 | "schema": { |
| 1512 | "type": "integer", |
| 1513 | "minimum": 1, |
| 1514 | "maximum": 100 |
| 1515 | } |
| 1516 | } |
| 1517 | ], |
| 1518 | "responses": { |
| 1519 | "200": { |
| 1520 | "description": "App-backed file list", |
| 1521 | "content": { |
| 1522 | "application/json": { |
| 1523 | "schema": { |
| 1524 | "$ref": "#/components/schemas/AppFilesListResponse" |
| 1525 | } |
| 1526 | } |
| 1527 | } |
| 1528 | } |
| 1529 | } |
| 1530 | }, |
| 1531 | "post": { |
| 1532 | "tags": [ |
| 1533 | "Runtime" |
| 1534 | ], |
| 1535 | "summary": "Create an app-backed file", |
| 1536 | "operationId": "createAppFile", |
| 1537 | "security": [ |
| 1538 | { |
| 1539 | "bearerAuth": [] |
| 1540 | } |
| 1541 | ], |
| 1542 | "parameters": [ |
| 1543 | { |
| 1544 | "name": "workspaceSlug", |
| 1545 | "in": "path", |
| 1546 | "required": true, |
| 1547 | "schema": { |
| 1548 | "type": "string" |
| 1549 | } |
| 1550 | }, |
| 1551 | { |
| 1552 | "name": "appKey", |
| 1553 | "in": "path", |
| 1554 | "required": true, |
| 1555 | "schema": { |
| 1556 | "type": "string" |
| 1557 | } |
| 1558 | } |
| 1559 | ], |
| 1560 | "requestBody": { |
| 1561 | "required": true, |
| 1562 | "content": { |
| 1563 | "application/json": { |
| 1564 | "schema": { |
| 1565 | "$ref": "#/components/schemas/CreateAppFileInput" |
| 1566 | } |
| 1567 | } |
| 1568 | } |
| 1569 | }, |
| 1570 | "responses": { |
| 1571 | "201": { |
| 1572 | "description": "Created app-backed file", |
| 1573 | "content": { |
| 1574 | "application/json": { |
| 1575 | "schema": { |
| 1576 | "$ref": "#/components/schemas/CreateAppFileResponse" |
| 1577 | } |
| 1578 | } |
| 1579 | } |
| 1580 | } |
| 1581 | } |
| 1582 | } |
| 1583 | }, |
| 1584 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/actions": { |
| 1585 | "post": { |
| 1586 | "tags": [ |
| 1587 | "Runtime" |
| 1588 | ], |
| 1589 | "summary": "Execute a hosted app action", |
| 1590 | "operationId": "executeAppAction", |
| 1591 | "security": [ |
| 1592 | { |
| 1593 | "bearerAuth": [] |
| 1594 | } |
| 1595 | ], |
| 1596 | "parameters": [ |
| 1597 | { |
| 1598 | "name": "workspaceSlug", |
| 1599 | "in": "path", |
| 1600 | "required": true, |
| 1601 | "schema": { |
| 1602 | "type": "string" |
| 1603 | } |
| 1604 | }, |
| 1605 | { |
| 1606 | "name": "appKey", |
| 1607 | "in": "path", |
| 1608 | "required": true, |
| 1609 | "schema": { |
| 1610 | "type": "string" |
| 1611 | } |
| 1612 | } |
| 1613 | ], |
| 1614 | "requestBody": { |
| 1615 | "required": true, |
| 1616 | "content": { |
| 1617 | "application/json": { |
| 1618 | "schema": { |
| 1619 | "$ref": "#/components/schemas/ExecuteAppActionInput" |
| 1620 | } |
| 1621 | } |
| 1622 | } |
| 1623 | }, |
| 1624 | "responses": { |
| 1625 | "200": { |
| 1626 | "description": "Hosted app action result", |
| 1627 | "content": { |
| 1628 | "application/json": { |
| 1629 | "schema": { |
| 1630 | "$ref": "#/components/schemas/ExecuteAppActionResponse" |
| 1631 | } |
| 1632 | } |
| 1633 | } |
| 1634 | } |
| 1635 | } |
| 1636 | } |
| 1637 | }, |
| 1638 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/notifications": { |
| 1639 | "post": { |
| 1640 | "tags": [ |
| 1641 | "Runtime" |
| 1642 | ], |
| 1643 | "summary": "Create an app notification", |
| 1644 | "operationId": "createAppNotification", |
| 1645 | "security": [ |
| 1646 | { |
| 1647 | "bearerAuth": [] |
| 1648 | } |
| 1649 | ], |
| 1650 | "parameters": [ |
| 1651 | { |
| 1652 | "name": "workspaceSlug", |
| 1653 | "in": "path", |
| 1654 | "required": true, |
| 1655 | "schema": { |
| 1656 | "type": "string" |
| 1657 | } |
| 1658 | }, |
| 1659 | { |
| 1660 | "name": "appKey", |
| 1661 | "in": "path", |
| 1662 | "required": true, |
| 1663 | "schema": { |
| 1664 | "type": "string" |
| 1665 | } |
| 1666 | } |
| 1667 | ], |
| 1668 | "requestBody": { |
| 1669 | "required": true, |
| 1670 | "content": { |
| 1671 | "application/json": { |
| 1672 | "schema": { |
| 1673 | "$ref": "#/components/schemas/CreateAppNotificationInput" |
| 1674 | } |
| 1675 | } |
| 1676 | } |
| 1677 | }, |
| 1678 | "responses": { |
| 1679 | "201": { |
| 1680 | "description": "Notification created", |
| 1681 | "content": { |
| 1682 | "application/json": { |
| 1683 | "schema": { |
| 1684 | "$ref": "#/components/schemas/OkResponse" |
| 1685 | } |
| 1686 | } |
| 1687 | } |
| 1688 | } |
| 1689 | } |
| 1690 | } |
| 1691 | }, |
| 1692 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/index-documents": { |
| 1693 | "post": { |
| 1694 | "tags": [ |
| 1695 | "Runtime" |
| 1696 | ], |
| 1697 | "summary": "Upsert app index documents", |
| 1698 | "operationId": "upsertAppIndexDocuments", |
| 1699 | "security": [ |
| 1700 | { |
| 1701 | "bearerAuth": [] |
| 1702 | } |
| 1703 | ], |
| 1704 | "parameters": [ |
| 1705 | { |
| 1706 | "name": "workspaceSlug", |
| 1707 | "in": "path", |
| 1708 | "required": true, |
| 1709 | "schema": { |
| 1710 | "type": "string" |
| 1711 | } |
| 1712 | }, |
| 1713 | { |
| 1714 | "name": "appKey", |
| 1715 | "in": "path", |
| 1716 | "required": true, |
| 1717 | "schema": { |
| 1718 | "type": "string" |
| 1719 | } |
| 1720 | } |
| 1721 | ], |
| 1722 | "requestBody": { |
| 1723 | "required": true, |
| 1724 | "content": { |
| 1725 | "application/json": { |
| 1726 | "schema": { |
| 1727 | "$ref": "#/components/schemas/UpsertAppIndexDocumentsInput" |
| 1728 | } |
| 1729 | } |
| 1730 | } |
| 1731 | }, |
| 1732 | "responses": { |
| 1733 | "201": { |
| 1734 | "description": "Index documents upserted", |
| 1735 | "content": { |
| 1736 | "application/json": { |
| 1737 | "schema": { |
| 1738 | "$ref": "#/components/schemas/UpsertAppIndexDocumentsResponse" |
| 1739 | } |
| 1740 | } |
| 1741 | } |
| 1742 | } |
| 1743 | } |
| 1744 | }, |
| 1745 | "delete": { |
| 1746 | "tags": [ |
| 1747 | "Runtime" |
| 1748 | ], |
| 1749 | "summary": "Delete app index documents", |
| 1750 | "operationId": "deleteAppIndexDocuments", |
| 1751 | "security": [ |
| 1752 | { |
| 1753 | "bearerAuth": [] |
| 1754 | } |
| 1755 | ], |
| 1756 | "parameters": [ |
| 1757 | { |
| 1758 | "name": "workspaceSlug", |
| 1759 | "in": "path", |
| 1760 | "required": true, |
| 1761 | "schema": { |
| 1762 | "type": "string" |
| 1763 | } |
| 1764 | }, |
| 1765 | { |
| 1766 | "name": "appKey", |
| 1767 | "in": "path", |
| 1768 | "required": true, |
| 1769 | "schema": { |
| 1770 | "type": "string" |
| 1771 | } |
| 1772 | } |
| 1773 | ], |
| 1774 | "requestBody": { |
| 1775 | "required": true, |
| 1776 | "content": { |
| 1777 | "application/json": { |
| 1778 | "schema": { |
| 1779 | "$ref": "#/components/schemas/DeleteAppIndexDocumentsInput" |
| 1780 | } |
| 1781 | } |
| 1782 | } |
| 1783 | }, |
| 1784 | "responses": { |
| 1785 | "200": { |
| 1786 | "description": "Index documents deleted", |
| 1787 | "content": { |
| 1788 | "application/json": { |
| 1789 | "schema": { |
| 1790 | "$ref": "#/components/schemas/DeleteAppIndexDocumentsResponse" |
| 1791 | } |
| 1792 | } |
| 1793 | } |
| 1794 | } |
| 1795 | } |
| 1796 | } |
| 1797 | }, |
| 1798 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/ambient/events": { |
| 1799 | "post": { |
| 1800 | "tags": [ |
| 1801 | "Runtime" |
| 1802 | ], |
| 1803 | "summary": "Emit app ambient events", |
| 1804 | "operationId": "emitAppAmbientEvents", |
| 1805 | "security": [ |
| 1806 | { |
| 1807 | "bearerAuth": [] |
| 1808 | } |
| 1809 | ], |
| 1810 | "parameters": [ |
| 1811 | { |
| 1812 | "name": "workspaceSlug", |
| 1813 | "in": "path", |
| 1814 | "required": true, |
| 1815 | "schema": { |
| 1816 | "type": "string" |
| 1817 | } |
| 1818 | }, |
| 1819 | { |
| 1820 | "name": "appKey", |
| 1821 | "in": "path", |
| 1822 | "required": true, |
| 1823 | "schema": { |
| 1824 | "type": "string" |
| 1825 | } |
| 1826 | } |
| 1827 | ], |
| 1828 | "requestBody": { |
| 1829 | "required": true, |
| 1830 | "content": { |
| 1831 | "application/json": { |
| 1832 | "schema": { |
| 1833 | "$ref": "#/components/schemas/EmitAppAmbientEventsInput" |
| 1834 | } |
| 1835 | } |
| 1836 | } |
| 1837 | }, |
| 1838 | "responses": { |
| 1839 | "201": { |
| 1840 | "description": "Ambient events accepted", |
| 1841 | "content": { |
| 1842 | "application/json": { |
| 1843 | "schema": { |
| 1844 | "$ref": "#/components/schemas/EmitAppAmbientEventsResponse" |
| 1845 | } |
| 1846 | } |
| 1847 | } |
| 1848 | } |
| 1849 | } |
| 1850 | } |
| 1851 | }, |
| 1852 | "/api/v1/workspaces/{workspaceSlug}/members": { |
| 1853 | "get": { |
| 1854 | "tags": ["Members"], |
| 1855 | "summary": "List workspace members", |
| 1856 | "operationId": "listWorkspaceMembers", |
| 1857 | "security": [{ "bearerAuth": [] }], |
| 1858 | "parameters": [ |
| 1859 | { |
| 1860 | "name": "workspaceSlug", |
| 1861 | "in": "path", |
| 1862 | "required": true, |
| 1863 | "schema": { "type": "string" } |
| 1864 | } |
| 1865 | ], |
| 1866 | "responses": { |
| 1867 | "200": { |
| 1868 | "description": "List of workspace members", |
| 1869 | "content": { |
| 1870 | "application/json": { |
| 1871 | "schema": { "$ref": "#/components/schemas/ListWorkspaceMembersResponse" } |
| 1872 | } |
| 1873 | } |
| 1874 | }, |
| 1875 | "401": { |
| 1876 | "description": "Unauthorized", |
| 1877 | "content": { |
| 1878 | "application/json": { |
| 1879 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 1880 | } |
| 1881 | } |
| 1882 | } |
| 1883 | } |
| 1884 | } |
| 1885 | }, |
| 1886 | "/api/v1/workspaces/{workspaceSlug}/docs": { |
| 1887 | "get": { |
| 1888 | "tags": ["Docs"], |
| 1889 | "summary": "List workspace docs", |
| 1890 | "operationId": "listWorkspaceDocs", |
| 1891 | "security": [{ "bearerAuth": [] }], |
| 1892 | "parameters": [ |
| 1893 | { |
| 1894 | "name": "workspaceSlug", |
| 1895 | "in": "path", |
| 1896 | "required": true, |
| 1897 | "schema": { "type": "string" } |
| 1898 | }, |
| 1899 | { |
| 1900 | "name": "q", |
| 1901 | "in": "query", |
| 1902 | "required": false, |
| 1903 | "description": "Search docs by title", |
| 1904 | "schema": { "type": "string", "maxLength": 200 } |
| 1905 | }, |
| 1906 | { |
| 1907 | "name": "limit", |
| 1908 | "in": "query", |
| 1909 | "required": false, |
| 1910 | "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } |
| 1911 | }, |
| 1912 | { |
| 1913 | "name": "cursor", |
| 1914 | "in": "query", |
| 1915 | "required": false, |
| 1916 | "description": "Opaque pagination cursor from a previous response", |
| 1917 | "schema": { "type": "string" } |
| 1918 | } |
| 1919 | ], |
| 1920 | "responses": { |
| 1921 | "200": { |
| 1922 | "description": "Paginated list of docs", |
| 1923 | "content": { |
| 1924 | "application/json": { |
| 1925 | "schema": { "$ref": "#/components/schemas/ListWorkspaceDocsResponse" } |
| 1926 | } |
| 1927 | } |
| 1928 | }, |
| 1929 | "400": { |
| 1930 | "description": "Invalid query parameters", |
| 1931 | "content": { |
| 1932 | "application/json": { |
| 1933 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 1934 | } |
| 1935 | } |
| 1936 | } |
| 1937 | } |
| 1938 | }, |
| 1939 | "post": { |
| 1940 | "tags": ["Docs"], |
| 1941 | "summary": "Create a workspace doc", |
| 1942 | "operationId": "createWorkspaceDoc", |
| 1943 | "security": [{ "bearerAuth": [] }], |
| 1944 | "parameters": [ |
| 1945 | { |
| 1946 | "name": "workspaceSlug", |
| 1947 | "in": "path", |
| 1948 | "required": true, |
| 1949 | "schema": { "type": "string" } |
| 1950 | } |
| 1951 | ], |
| 1952 | "requestBody": { |
| 1953 | "required": true, |
| 1954 | "content": { |
| 1955 | "application/json": { |
| 1956 | "schema": { "$ref": "#/components/schemas/CreateDocInput" } |
| 1957 | } |
| 1958 | } |
| 1959 | }, |
| 1960 | "responses": { |
| 1961 | "201": { |
| 1962 | "description": "Created doc", |
| 1963 | "content": { |
| 1964 | "application/json": { |
| 1965 | "schema": { "$ref": "#/components/schemas/DocResponse" } |
| 1966 | } |
| 1967 | } |
| 1968 | }, |
| 1969 | "400": { |
| 1970 | "description": "Validation error", |
| 1971 | "content": { |
| 1972 | "application/json": { |
| 1973 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 1974 | } |
| 1975 | } |
| 1976 | } |
| 1977 | } |
| 1978 | } |
| 1979 | }, |
| 1980 | "/api/v1/workspaces/{workspaceSlug}/docs/{docId}": { |
| 1981 | "get": { |
| 1982 | "tags": ["Docs"], |
| 1983 | "summary": "Get a workspace doc with full content", |
| 1984 | "operationId": "getWorkspaceDoc", |
| 1985 | "security": [{ "bearerAuth": [] }], |
| 1986 | "parameters": [ |
| 1987 | { |
| 1988 | "name": "workspaceSlug", |
| 1989 | "in": "path", |
| 1990 | "required": true, |
| 1991 | "schema": { "type": "string" } |
| 1992 | }, |
| 1993 | { |
| 1994 | "name": "docId", |
| 1995 | "in": "path", |
| 1996 | "required": true, |
| 1997 | "schema": { "type": "string" } |
| 1998 | } |
| 1999 | ], |
| 2000 | "responses": { |
| 2001 | "200": { |
| 2002 | "description": "Doc with full content and layout", |
| 2003 | "content": { |
| 2004 | "application/json": { |
| 2005 | "schema": { "$ref": "#/components/schemas/DocDetailResponse" } |
| 2006 | } |
| 2007 | } |
| 2008 | }, |
| 2009 | "404": { |
| 2010 | "description": "Doc not found", |
| 2011 | "content": { |
| 2012 | "application/json": { |
| 2013 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2014 | } |
| 2015 | } |
| 2016 | } |
| 2017 | } |
| 2018 | }, |
| 2019 | "patch": { |
| 2020 | "tags": ["Docs"], |
| 2021 | "summary": "Update a workspace doc", |
| 2022 | "operationId": "updateWorkspaceDoc", |
| 2023 | "security": [{ "bearerAuth": [] }], |
| 2024 | "parameters": [ |
| 2025 | { |
| 2026 | "name": "workspaceSlug", |
| 2027 | "in": "path", |
| 2028 | "required": true, |
| 2029 | "schema": { "type": "string" } |
| 2030 | }, |
| 2031 | { |
| 2032 | "name": "docId", |
| 2033 | "in": "path", |
| 2034 | "required": true, |
| 2035 | "schema": { "type": "string" } |
| 2036 | } |
| 2037 | ], |
| 2038 | "requestBody": { |
| 2039 | "required": true, |
| 2040 | "content": { |
| 2041 | "application/json": { |
| 2042 | "schema": { "$ref": "#/components/schemas/UpdateDocInput" } |
| 2043 | } |
| 2044 | } |
| 2045 | }, |
| 2046 | "responses": { |
| 2047 | "200": { |
| 2048 | "description": "Updated doc", |
| 2049 | "content": { |
| 2050 | "application/json": { |
| 2051 | "schema": { "$ref": "#/components/schemas/DocDetailResponse" } |
| 2052 | } |
| 2053 | } |
| 2054 | }, |
| 2055 | "400": { |
| 2056 | "description": "Validation error", |
| 2057 | "content": { |
| 2058 | "application/json": { |
| 2059 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2060 | } |
| 2061 | } |
| 2062 | }, |
| 2063 | "404": { |
| 2064 | "description": "Doc not found", |
| 2065 | "content": { |
| 2066 | "application/json": { |
| 2067 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2068 | } |
| 2069 | } |
| 2070 | } |
| 2071 | } |
| 2072 | }, |
| 2073 | "delete": { |
| 2074 | "tags": ["Docs"], |
| 2075 | "summary": "Delete (trash) a workspace doc", |
| 2076 | "operationId": "deleteWorkspaceDoc", |
| 2077 | "security": [{ "bearerAuth": [] }], |
| 2078 | "parameters": [ |
| 2079 | { |
| 2080 | "name": "workspaceSlug", |
| 2081 | "in": "path", |
| 2082 | "required": true, |
| 2083 | "schema": { "type": "string" } |
| 2084 | }, |
| 2085 | { |
| 2086 | "name": "docId", |
| 2087 | "in": "path", |
| 2088 | "required": true, |
| 2089 | "schema": { "type": "string" } |
| 2090 | } |
| 2091 | ], |
| 2092 | "responses": { |
| 2093 | "200": { |
| 2094 | "description": "Doc trashed", |
| 2095 | "content": { |
| 2096 | "application/json": { |
| 2097 | "schema": { "$ref": "#/components/schemas/OkResponse" } |
| 2098 | } |
| 2099 | } |
| 2100 | }, |
| 2101 | "404": { |
| 2102 | "description": "Doc not found", |
| 2103 | "content": { |
| 2104 | "application/json": { |
| 2105 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2106 | } |
| 2107 | } |
| 2108 | } |
| 2109 | } |
| 2110 | } |
| 2111 | }, |
| 2112 | "/api/v1/workspaces/{workspaceSlug}/drives": { |
| 2113 | "get": { |
| 2114 | "tags": ["Drives"], |
| 2115 | "summary": "List workspace drives", |
| 2116 | "operationId": "listWorkspaceDrives", |
| 2117 | "security": [{ "bearerAuth": [] }], |
| 2118 | "parameters": [ |
| 2119 | { |
| 2120 | "name": "workspaceSlug", |
| 2121 | "in": "path", |
| 2122 | "required": true, |
| 2123 | "schema": { "type": "string" } |
| 2124 | } |
| 2125 | ], |
| 2126 | "responses": { |
| 2127 | "200": { |
| 2128 | "description": "List of workspace drives", |
| 2129 | "content": { |
| 2130 | "application/json": { |
| 2131 | "schema": { "$ref": "#/components/schemas/ListWorkspaceDrivesResponse" } |
| 2132 | } |
| 2133 | } |
| 2134 | } |
| 2135 | } |
| 2136 | } |
| 2137 | }, |
| 2138 | "/api/v1/workspaces/{workspaceSlug}/drives/{driveId}/files": { |
| 2139 | "get": { |
| 2140 | "tags": ["Files"], |
| 2141 | "summary": "List files in a drive", |
| 2142 | "operationId": "listDriveFiles", |
| 2143 | "security": [{ "bearerAuth": [] }], |
| 2144 | "parameters": [ |
| 2145 | { |
| 2146 | "name": "workspaceSlug", |
| 2147 | "in": "path", |
| 2148 | "required": true, |
| 2149 | "schema": { "type": "string" } |
| 2150 | }, |
| 2151 | { |
| 2152 | "name": "driveId", |
| 2153 | "in": "path", |
| 2154 | "required": true, |
| 2155 | "schema": { "type": "string" } |
| 2156 | }, |
| 2157 | { |
| 2158 | "name": "parentId", |
| 2159 | "in": "query", |
| 2160 | "required": false, |
| 2161 | "description": "List files inside this folder", |
| 2162 | "schema": { "type": "string" } |
| 2163 | }, |
| 2164 | { |
| 2165 | "name": "fileType", |
| 2166 | "in": "query", |
| 2167 | "required": false, |
| 2168 | "description": "Filter by file type (e.g. doc, note, folder)", |
| 2169 | "schema": { "type": "string" } |
| 2170 | }, |
| 2171 | { |
| 2172 | "name": "trashed", |
| 2173 | "in": "query", |
| 2174 | "required": false, |
| 2175 | "schema": { "type": "boolean", "default": false } |
| 2176 | }, |
| 2177 | { |
| 2178 | "name": "limit", |
| 2179 | "in": "query", |
| 2180 | "required": false, |
| 2181 | "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } |
| 2182 | }, |
| 2183 | { |
| 2184 | "name": "cursor", |
| 2185 | "in": "query", |
| 2186 | "required": false, |
| 2187 | "description": "Opaque pagination cursor", |
| 2188 | "schema": { "type": "string" } |
| 2189 | } |
| 2190 | ], |
| 2191 | "responses": { |
| 2192 | "200": { |
| 2193 | "description": "Paginated list of files", |
| 2194 | "content": { |
| 2195 | "application/json": { |
| 2196 | "schema": { "$ref": "#/components/schemas/ListDriveFilesResponse" } |
| 2197 | } |
| 2198 | } |
| 2199 | }, |
| 2200 | "400": { |
| 2201 | "description": "Invalid query parameters", |
| 2202 | "content": { |
| 2203 | "application/json": { |
| 2204 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2205 | } |
| 2206 | } |
| 2207 | }, |
| 2208 | "404": { |
| 2209 | "description": "Drive not found", |
| 2210 | "content": { |
| 2211 | "application/json": { |
| 2212 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2213 | } |
| 2214 | } |
| 2215 | } |
| 2216 | } |
| 2217 | } |
| 2218 | }, |
| 2219 | "/api/v1/workspaces/{workspaceSlug}/files/{fileId}": { |
| 2220 | "get": { |
| 2221 | "tags": ["Files"], |
| 2222 | "summary": "Get file metadata", |
| 2223 | "operationId": "getFile", |
| 2224 | "security": [{ "bearerAuth": [] }], |
| 2225 | "parameters": [ |
| 2226 | { |
| 2227 | "name": "workspaceSlug", |
| 2228 | "in": "path", |
| 2229 | "required": true, |
| 2230 | "schema": { "type": "string" } |
| 2231 | }, |
| 2232 | { |
| 2233 | "name": "fileId", |
| 2234 | "in": "path", |
| 2235 | "required": true, |
| 2236 | "schema": { "type": "string" } |
| 2237 | } |
| 2238 | ], |
| 2239 | "responses": { |
| 2240 | "200": { |
| 2241 | "description": "File metadata", |
| 2242 | "content": { |
| 2243 | "application/json": { |
| 2244 | "schema": { "$ref": "#/components/schemas/FileDetailResponse" } |
| 2245 | } |
| 2246 | } |
| 2247 | }, |
| 2248 | "404": { |
| 2249 | "description": "File not found", |
| 2250 | "content": { |
| 2251 | "application/json": { |
| 2252 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2253 | } |
| 2254 | } |
| 2255 | } |
| 2256 | } |
| 2257 | }, |
| 2258 | "patch": { |
| 2259 | "tags": ["Files"], |
| 2260 | "summary": "Update a file (rename, move, recolor)", |
| 2261 | "operationId": "updateFile", |
| 2262 | "security": [{ "bearerAuth": [] }], |
| 2263 | "parameters": [ |
| 2264 | { |
| 2265 | "name": "workspaceSlug", |
| 2266 | "in": "path", |
| 2267 | "required": true, |
| 2268 | "schema": { "type": "string" } |
| 2269 | }, |
| 2270 | { |
| 2271 | "name": "fileId", |
| 2272 | "in": "path", |
| 2273 | "required": true, |
| 2274 | "schema": { "type": "string" } |
| 2275 | } |
| 2276 | ], |
| 2277 | "requestBody": { |
| 2278 | "required": true, |
| 2279 | "content": { |
| 2280 | "application/json": { |
| 2281 | "schema": { "$ref": "#/components/schemas/UpdateFileInput" } |
| 2282 | } |
| 2283 | } |
| 2284 | }, |
| 2285 | "responses": { |
| 2286 | "200": { |
| 2287 | "description": "Updated file", |
| 2288 | "content": { |
| 2289 | "application/json": { |
| 2290 | "schema": { "$ref": "#/components/schemas/FileDetailResponse" } |
| 2291 | } |
| 2292 | } |
| 2293 | }, |
| 2294 | "400": { |
| 2295 | "description": "Validation error", |
| 2296 | "content": { |
| 2297 | "application/json": { |
| 2298 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2299 | } |
| 2300 | } |
| 2301 | }, |
| 2302 | "404": { |
| 2303 | "description": "File not found", |
| 2304 | "content": { |
| 2305 | "application/json": { |
| 2306 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2307 | } |
| 2308 | } |
| 2309 | } |
| 2310 | } |
| 2311 | }, |
| 2312 | "delete": { |
| 2313 | "tags": ["Files"], |
| 2314 | "summary": "Delete (trash) a file", |
| 2315 | "operationId": "deleteFile", |
| 2316 | "security": [{ "bearerAuth": [] }], |
| 2317 | "parameters": [ |
| 2318 | { |
| 2319 | "name": "workspaceSlug", |
| 2320 | "in": "path", |
| 2321 | "required": true, |
| 2322 | "schema": { "type": "string" } |
| 2323 | }, |
| 2324 | { |
| 2325 | "name": "fileId", |
| 2326 | "in": "path", |
| 2327 | "required": true, |
| 2328 | "schema": { "type": "string" } |
| 2329 | } |
| 2330 | ], |
| 2331 | "responses": { |
| 2332 | "200": { |
| 2333 | "description": "File trashed", |
| 2334 | "content": { |
| 2335 | "application/json": { |
| 2336 | "schema": { "$ref": "#/components/schemas/OkResponse" } |
| 2337 | } |
| 2338 | } |
| 2339 | }, |
| 2340 | "404": { |
| 2341 | "description": "File not found", |
| 2342 | "content": { |
| 2343 | "application/json": { |
| 2344 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2345 | } |
| 2346 | } |
| 2347 | } |
| 2348 | } |
| 2349 | } |
| 2350 | }, |
| 2351 | "/api/v1/workspaces/{workspaceSlug}/notes": { |
| 2352 | "get": { |
| 2353 | "tags": ["Notes"], |
| 2354 | "summary": "List workspace notes", |
| 2355 | "operationId": "listWorkspaceNotes", |
| 2356 | "security": [{ "bearerAuth": [] }], |
| 2357 | "parameters": [ |
| 2358 | { |
| 2359 | "name": "workspaceSlug", |
| 2360 | "in": "path", |
| 2361 | "required": true, |
| 2362 | "schema": { "type": "string" } |
| 2363 | }, |
| 2364 | { |
| 2365 | "name": "q", |
| 2366 | "in": "query", |
| 2367 | "required": false, |
| 2368 | "description": "Search notes by title", |
| 2369 | "schema": { "type": "string", "maxLength": 200 } |
| 2370 | }, |
| 2371 | { |
| 2372 | "name": "limit", |
| 2373 | "in": "query", |
| 2374 | "required": false, |
| 2375 | "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } |
| 2376 | }, |
| 2377 | { |
| 2378 | "name": "cursor", |
| 2379 | "in": "query", |
| 2380 | "required": false, |
| 2381 | "description": "Opaque pagination cursor from a previous response", |
| 2382 | "schema": { "type": "string" } |
| 2383 | } |
| 2384 | ], |
| 2385 | "responses": { |
| 2386 | "200": { |
| 2387 | "description": "Paginated list of notes", |
| 2388 | "content": { |
| 2389 | "application/json": { |
| 2390 | "schema": { "$ref": "#/components/schemas/ListWorkspaceNotesResponse" } |
| 2391 | } |
| 2392 | } |
| 2393 | }, |
| 2394 | "400": { |
| 2395 | "description": "Invalid query parameters", |
| 2396 | "content": { |
| 2397 | "application/json": { |
| 2398 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2399 | } |
| 2400 | } |
| 2401 | } |
| 2402 | } |
| 2403 | }, |
| 2404 | "post": { |
| 2405 | "tags": ["Notes"], |
| 2406 | "summary": "Create a workspace note", |
| 2407 | "operationId": "createWorkspaceNote", |
| 2408 | "security": [{ "bearerAuth": [] }], |
| 2409 | "parameters": [ |
| 2410 | { |
| 2411 | "name": "workspaceSlug", |
| 2412 | "in": "path", |
| 2413 | "required": true, |
| 2414 | "schema": { "type": "string" } |
| 2415 | } |
| 2416 | ], |
| 2417 | "requestBody": { |
| 2418 | "required": true, |
| 2419 | "content": { |
| 2420 | "application/json": { |
| 2421 | "schema": { "$ref": "#/components/schemas/CreateNoteInput" } |
| 2422 | } |
| 2423 | } |
| 2424 | }, |
| 2425 | "responses": { |
| 2426 | "201": { |
| 2427 | "description": "Created note", |
| 2428 | "content": { |
| 2429 | "application/json": { |
| 2430 | "schema": { "$ref": "#/components/schemas/NoteResponse" } |
| 2431 | } |
| 2432 | } |
| 2433 | }, |
| 2434 | "400": { |
| 2435 | "description": "Validation error", |
| 2436 | "content": { |
| 2437 | "application/json": { |
| 2438 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2439 | } |
| 2440 | } |
| 2441 | } |
| 2442 | } |
| 2443 | } |
| 2444 | }, |
| 2445 | "/api/v1/workspaces/{workspaceSlug}/notes/{noteId}": { |
| 2446 | "get": { |
| 2447 | "tags": ["Notes"], |
| 2448 | "summary": "Get a workspace note with content", |
| 2449 | "operationId": "getWorkspaceNote", |
| 2450 | "security": [{ "bearerAuth": [] }], |
| 2451 | "parameters": [ |
| 2452 | { |
| 2453 | "name": "workspaceSlug", |
| 2454 | "in": "path", |
| 2455 | "required": true, |
| 2456 | "schema": { "type": "string" } |
| 2457 | }, |
| 2458 | { |
| 2459 | "name": "noteId", |
| 2460 | "in": "path", |
| 2461 | "required": true, |
| 2462 | "schema": { "type": "string" } |
| 2463 | } |
| 2464 | ], |
| 2465 | "responses": { |
| 2466 | "200": { |
| 2467 | "description": "Note with full content", |
| 2468 | "content": { |
| 2469 | "application/json": { |
| 2470 | "schema": { "$ref": "#/components/schemas/NoteDetailResponse" } |
| 2471 | } |
| 2472 | } |
| 2473 | }, |
| 2474 | "404": { |
| 2475 | "description": "Note not found", |
| 2476 | "content": { |
| 2477 | "application/json": { |
| 2478 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2479 | } |
| 2480 | } |
| 2481 | } |
| 2482 | } |
| 2483 | }, |
| 2484 | "put": { |
| 2485 | "tags": ["Notes"], |
| 2486 | "summary": "Update a workspace note", |
| 2487 | "operationId": "updateWorkspaceNote", |
| 2488 | "security": [{ "bearerAuth": [] }], |
| 2489 | "parameters": [ |
| 2490 | { |
| 2491 | "name": "workspaceSlug", |
| 2492 | "in": "path", |
| 2493 | "required": true, |
| 2494 | "schema": { "type": "string" } |
| 2495 | }, |
| 2496 | { |
| 2497 | "name": "noteId", |
| 2498 | "in": "path", |
| 2499 | "required": true, |
| 2500 | "schema": { "type": "string" } |
| 2501 | } |
| 2502 | ], |
| 2503 | "requestBody": { |
| 2504 | "required": true, |
| 2505 | "content": { |
| 2506 | "application/json": { |
| 2507 | "schema": { "$ref": "#/components/schemas/UpdateNoteInput" } |
| 2508 | } |
| 2509 | } |
| 2510 | }, |
| 2511 | "responses": { |
| 2512 | "200": { |
| 2513 | "description": "Updated note", |
| 2514 | "content": { |
| 2515 | "application/json": { |
| 2516 | "schema": { "$ref": "#/components/schemas/NoteResponse" } |
| 2517 | } |
| 2518 | } |
| 2519 | }, |
| 2520 | "400": { |
| 2521 | "description": "Validation error", |
| 2522 | "content": { |
| 2523 | "application/json": { |
| 2524 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2525 | } |
| 2526 | } |
| 2527 | }, |
| 2528 | "404": { |
| 2529 | "description": "Note not found", |
| 2530 | "content": { |
| 2531 | "application/json": { |
| 2532 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2533 | } |
| 2534 | } |
| 2535 | } |
| 2536 | } |
| 2537 | }, |
| 2538 | "delete": { |
| 2539 | "tags": ["Notes"], |
| 2540 | "summary": "Delete (trash) a workspace note", |
| 2541 | "operationId": "deleteWorkspaceNote", |
| 2542 | "security": [{ "bearerAuth": [] }], |
| 2543 | "parameters": [ |
| 2544 | { |
| 2545 | "name": "workspaceSlug", |
| 2546 | "in": "path", |
| 2547 | "required": true, |
| 2548 | "schema": { "type": "string" } |
| 2549 | }, |
| 2550 | { |
| 2551 | "name": "noteId", |
| 2552 | "in": "path", |
| 2553 | "required": true, |
| 2554 | "schema": { "type": "string" } |
| 2555 | } |
| 2556 | ], |
| 2557 | "responses": { |
| 2558 | "200": { |
| 2559 | "description": "Note trashed", |
| 2560 | "content": { |
| 2561 | "application/json": { |
| 2562 | "schema": { "$ref": "#/components/schemas/OkResponse" } |
| 2563 | } |
| 2564 | } |
| 2565 | }, |
| 2566 | "404": { |
| 2567 | "description": "Note not found", |
| 2568 | "content": { |
| 2569 | "application/json": { |
| 2570 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2571 | } |
| 2572 | } |
| 2573 | } |
| 2574 | } |
| 2575 | } |
| 2576 | }, |
| 2577 | "/api/v1/workspaces/{workspaceSlug}/calendar/events": { |
| 2578 | "get": { |
| 2579 | "tags": ["Calendar"], |
| 2580 | "summary": "List calendar events in a date range", |
| 2581 | "operationId": "listCalendarEvents", |
| 2582 | "security": [{ "bearerAuth": [] }], |
| 2583 | "parameters": [ |
| 2584 | { |
| 2585 | "name": "workspaceSlug", |
| 2586 | "in": "path", |
| 2587 | "required": true, |
| 2588 | "schema": { "type": "string" } |
| 2589 | }, |
| 2590 | { |
| 2591 | "name": "start", |
| 2592 | "in": "query", |
| 2593 | "required": true, |
| 2594 | "description": "Range start as ISO 8601 datetime", |
| 2595 | "schema": { "type": "string", "format": "date-time" } |
| 2596 | }, |
| 2597 | { |
| 2598 | "name": "end", |
| 2599 | "in": "query", |
| 2600 | "required": true, |
| 2601 | "description": "Range end as ISO 8601 datetime", |
| 2602 | "schema": { "type": "string", "format": "date-time" } |
| 2603 | } |
| 2604 | ], |
| 2605 | "responses": { |
| 2606 | "200": { |
| 2607 | "description": "Calendar events in the requested range", |
| 2608 | "content": { |
| 2609 | "application/json": { |
| 2610 | "schema": { "$ref": "#/components/schemas/ListCalendarEventsResponse" } |
| 2611 | } |
| 2612 | } |
| 2613 | }, |
| 2614 | "400": { |
| 2615 | "description": "Invalid date range", |
| 2616 | "content": { |
| 2617 | "application/json": { |
| 2618 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2619 | } |
| 2620 | } |
| 2621 | } |
| 2622 | } |
| 2623 | }, |
| 2624 | "post": { |
| 2625 | "tags": ["Calendar"], |
| 2626 | "summary": "Create a calendar event", |
| 2627 | "operationId": "createCalendarEvent", |
| 2628 | "security": [{ "bearerAuth": [] }], |
| 2629 | "parameters": [ |
| 2630 | { |
| 2631 | "name": "workspaceSlug", |
| 2632 | "in": "path", |
| 2633 | "required": true, |
| 2634 | "schema": { "type": "string" } |
| 2635 | } |
| 2636 | ], |
| 2637 | "requestBody": { |
| 2638 | "required": true, |
| 2639 | "content": { |
| 2640 | "application/json": { |
| 2641 | "schema": { "$ref": "#/components/schemas/CreateCalendarEventInput" } |
| 2642 | } |
| 2643 | } |
| 2644 | }, |
| 2645 | "responses": { |
| 2646 | "201": { |
| 2647 | "description": "Created calendar event", |
| 2648 | "content": { |
| 2649 | "application/json": { |
| 2650 | "schema": { "$ref": "#/components/schemas/CalendarEventDetailResponse" } |
| 2651 | } |
| 2652 | } |
| 2653 | }, |
| 2654 | "400": { |
| 2655 | "description": "Validation error", |
| 2656 | "content": { |
| 2657 | "application/json": { |
| 2658 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2659 | } |
| 2660 | } |
| 2661 | } |
| 2662 | } |
| 2663 | } |
| 2664 | }, |
| 2665 | "/api/v1/workspaces/{workspaceSlug}/calendar/events/{eventId}": { |
| 2666 | "get": { |
| 2667 | "tags": ["Calendar"], |
| 2668 | "summary": "Get a calendar event", |
| 2669 | "operationId": "getCalendarEvent", |
| 2670 | "security": [{ "bearerAuth": [] }], |
| 2671 | "parameters": [ |
| 2672 | { |
| 2673 | "name": "workspaceSlug", |
| 2674 | "in": "path", |
| 2675 | "required": true, |
| 2676 | "schema": { "type": "string" } |
| 2677 | }, |
| 2678 | { |
| 2679 | "name": "eventId", |
| 2680 | "in": "path", |
| 2681 | "required": true, |
| 2682 | "schema": { "type": "string" } |
| 2683 | } |
| 2684 | ], |
| 2685 | "responses": { |
| 2686 | "200": { |
| 2687 | "description": "Calendar event detail", |
| 2688 | "content": { |
| 2689 | "application/json": { |
| 2690 | "schema": { "$ref": "#/components/schemas/CalendarEventDetailResponse" } |
| 2691 | } |
| 2692 | } |
| 2693 | }, |
| 2694 | "404": { |
| 2695 | "description": "Event not found", |
| 2696 | "content": { |
| 2697 | "application/json": { |
| 2698 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2699 | } |
| 2700 | } |
| 2701 | } |
| 2702 | } |
| 2703 | }, |
| 2704 | "patch": { |
| 2705 | "tags": ["Calendar"], |
| 2706 | "summary": "Update a calendar event", |
| 2707 | "operationId": "updateCalendarEvent", |
| 2708 | "security": [{ "bearerAuth": [] }], |
| 2709 | "parameters": [ |
| 2710 | { |
| 2711 | "name": "workspaceSlug", |
| 2712 | "in": "path", |
| 2713 | "required": true, |
| 2714 | "schema": { "type": "string" } |
| 2715 | }, |
| 2716 | { |
| 2717 | "name": "eventId", |
| 2718 | "in": "path", |
| 2719 | "required": true, |
| 2720 | "schema": { "type": "string" } |
| 2721 | } |
| 2722 | ], |
| 2723 | "requestBody": { |
| 2724 | "required": true, |
| 2725 | "content": { |
| 2726 | "application/json": { |
| 2727 | "schema": { "$ref": "#/components/schemas/UpdateCalendarEventInput" } |
| 2728 | } |
| 2729 | } |
| 2730 | }, |
| 2731 | "responses": { |
| 2732 | "200": { |
| 2733 | "description": "Updated calendar event", |
| 2734 | "content": { |
| 2735 | "application/json": { |
| 2736 | "schema": { "$ref": "#/components/schemas/CalendarEventDetailResponse" } |
| 2737 | } |
| 2738 | } |
| 2739 | }, |
| 2740 | "400": { |
| 2741 | "description": "Validation error", |
| 2742 | "content": { |
| 2743 | "application/json": { |
| 2744 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2745 | } |
| 2746 | } |
| 2747 | }, |
| 2748 | "404": { |
| 2749 | "description": "Event not found", |
| 2750 | "content": { |
| 2751 | "application/json": { |
| 2752 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2753 | } |
| 2754 | } |
| 2755 | } |
| 2756 | } |
| 2757 | }, |
| 2758 | "delete": { |
| 2759 | "tags": ["Calendar"], |
| 2760 | "summary": "Delete a calendar event", |
| 2761 | "operationId": "deleteCalendarEvent", |
| 2762 | "security": [{ "bearerAuth": [] }], |
| 2763 | "parameters": [ |
| 2764 | { |
| 2765 | "name": "workspaceSlug", |
| 2766 | "in": "path", |
| 2767 | "required": true, |
| 2768 | "schema": { "type": "string" } |
| 2769 | }, |
| 2770 | { |
| 2771 | "name": "eventId", |
| 2772 | "in": "path", |
| 2773 | "required": true, |
| 2774 | "schema": { "type": "string" } |
| 2775 | } |
| 2776 | ], |
| 2777 | "responses": { |
| 2778 | "200": { |
| 2779 | "description": "Event deleted", |
| 2780 | "content": { |
| 2781 | "application/json": { |
| 2782 | "schema": { "$ref": "#/components/schemas/OkResponse" } |
| 2783 | } |
| 2784 | } |
| 2785 | }, |
| 2786 | "404": { |
| 2787 | "description": "Event not found", |
| 2788 | "content": { |
| 2789 | "application/json": { |
| 2790 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2791 | } |
| 2792 | } |
| 2793 | } |
| 2794 | } |
| 2795 | } |
| 2796 | }, |
| 2797 | "/api/v1/workspaces/{workspaceSlug}/search": { |
| 2798 | "post": { |
| 2799 | "tags": ["Search"], |
| 2800 | "summary": "Search workspace content", |
| 2801 | "operationId": "searchWorkspace", |
| 2802 | "security": [{ "bearerAuth": [] }], |
| 2803 | "parameters": [ |
| 2804 | { |
| 2805 | "name": "workspaceSlug", |
| 2806 | "in": "path", |
| 2807 | "required": true, |
| 2808 | "schema": { "type": "string" } |
| 2809 | } |
| 2810 | ], |
| 2811 | "requestBody": { |
| 2812 | "required": true, |
| 2813 | "content": { |
| 2814 | "application/json": { |
| 2815 | "schema": { "$ref": "#/components/schemas/WorkspaceSearchInput" } |
| 2816 | } |
| 2817 | } |
| 2818 | }, |
| 2819 | "responses": { |
| 2820 | "200": { |
| 2821 | "description": "Search results", |
| 2822 | "content": { |
| 2823 | "application/json": { |
| 2824 | "schema": { "$ref": "#/components/schemas/WorkspaceSearchResponse" } |
| 2825 | } |
| 2826 | } |
| 2827 | }, |
| 2828 | "400": { |
| 2829 | "description": "Validation error", |
| 2830 | "content": { |
| 2831 | "application/json": { |
| 2832 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2833 | } |
| 2834 | } |
| 2835 | } |
| 2836 | } |
| 2837 | } |
| 2838 | }, |
| 2839 | "/api/v1/workspaces/{workspaceSlug}/taskboards": { |
| 2840 | "get": { |
| 2841 | "tags": ["Tasks"], |
| 2842 | "summary": "List workspace taskboards", |
| 2843 | "operationId": "listWorkspaceTaskboards", |
| 2844 | "security": [{ "bearerAuth": [] }], |
| 2845 | "parameters": [ |
| 2846 | { |
| 2847 | "name": "workspaceSlug", |
| 2848 | "in": "path", |
| 2849 | "required": true, |
| 2850 | "schema": { "type": "string" } |
| 2851 | } |
| 2852 | ], |
| 2853 | "responses": { |
| 2854 | "200": { |
| 2855 | "description": "List of taskboards with statuses", |
| 2856 | "content": { |
| 2857 | "application/json": { |
| 2858 | "schema": { "$ref": "#/components/schemas/ListWorkspaceTaskboardsResponse" } |
| 2859 | } |
| 2860 | } |
| 2861 | } |
| 2862 | } |
| 2863 | } |
| 2864 | }, |
| 2865 | "/api/v1/workspaces/{workspaceSlug}/taskboards/{taskboardId}/tasks": { |
| 2866 | "get": { |
| 2867 | "tags": ["Tasks"], |
| 2868 | "summary": "List tasks on a taskboard", |
| 2869 | "operationId": "listTaskboardTasks", |
| 2870 | "security": [{ "bearerAuth": [] }], |
| 2871 | "parameters": [ |
| 2872 | { |
| 2873 | "name": "workspaceSlug", |
| 2874 | "in": "path", |
| 2875 | "required": true, |
| 2876 | "schema": { "type": "string" } |
| 2877 | }, |
| 2878 | { |
| 2879 | "name": "taskboardId", |
| 2880 | "in": "path", |
| 2881 | "required": true, |
| 2882 | "schema": { "type": "string" } |
| 2883 | }, |
| 2884 | { |
| 2885 | "name": "q", |
| 2886 | "in": "query", |
| 2887 | "required": false, |
| 2888 | "description": "Search tasks by title or description", |
| 2889 | "schema": { "type": "string", "maxLength": 200 } |
| 2890 | }, |
| 2891 | { |
| 2892 | "name": "statusId", |
| 2893 | "in": "query", |
| 2894 | "required": false, |
| 2895 | "description": "Filter by status ID", |
| 2896 | "schema": { "type": "string" } |
| 2897 | }, |
| 2898 | { |
| 2899 | "name": "assigneeUserId", |
| 2900 | "in": "query", |
| 2901 | "required": false, |
| 2902 | "description": "Filter by assignee user ID", |
| 2903 | "schema": { "type": "string" } |
| 2904 | }, |
| 2905 | { |
| 2906 | "name": "limit", |
| 2907 | "in": "query", |
| 2908 | "required": false, |
| 2909 | "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } |
| 2910 | } |
| 2911 | ], |
| 2912 | "responses": { |
| 2913 | "200": { |
| 2914 | "description": "List of tasks", |
| 2915 | "content": { |
| 2916 | "application/json": { |
| 2917 | "schema": { "$ref": "#/components/schemas/ListTaskboardTasksResponse" } |
| 2918 | } |
| 2919 | } |
| 2920 | }, |
| 2921 | "404": { |
| 2922 | "description": "Taskboard not found", |
| 2923 | "content": { |
| 2924 | "application/json": { |
| 2925 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2926 | } |
| 2927 | } |
| 2928 | } |
| 2929 | } |
| 2930 | }, |
| 2931 | "post": { |
| 2932 | "tags": ["Tasks"], |
| 2933 | "summary": "Create a task on a taskboard", |
| 2934 | "operationId": "createTaskboardTask", |
| 2935 | "security": [{ "bearerAuth": [] }], |
| 2936 | "parameters": [ |
| 2937 | { |
| 2938 | "name": "workspaceSlug", |
| 2939 | "in": "path", |
| 2940 | "required": true, |
| 2941 | "schema": { "type": "string" } |
| 2942 | }, |
| 2943 | { |
| 2944 | "name": "taskboardId", |
| 2945 | "in": "path", |
| 2946 | "required": true, |
| 2947 | "schema": { "type": "string" } |
| 2948 | } |
| 2949 | ], |
| 2950 | "requestBody": { |
| 2951 | "required": true, |
| 2952 | "content": { |
| 2953 | "application/json": { |
| 2954 | "schema": { "$ref": "#/components/schemas/CreateTaskInput" } |
| 2955 | } |
| 2956 | } |
| 2957 | }, |
| 2958 | "responses": { |
| 2959 | "201": { |
| 2960 | "description": "Created task", |
| 2961 | "content": { |
| 2962 | "application/json": { |
| 2963 | "schema": { "$ref": "#/components/schemas/CreateTaskResponse" } |
| 2964 | } |
| 2965 | } |
| 2966 | }, |
| 2967 | "400": { |
| 2968 | "description": "Validation error", |
| 2969 | "content": { |
| 2970 | "application/json": { |
| 2971 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2972 | } |
| 2973 | } |
| 2974 | }, |
| 2975 | "404": { |
| 2976 | "description": "Taskboard not found", |
| 2977 | "content": { |
| 2978 | "application/json": { |
| 2979 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 2980 | } |
| 2981 | } |
| 2982 | } |
| 2983 | } |
| 2984 | } |
| 2985 | }, |
| 2986 | "/api/v1/workspaces/{workspaceSlug}/taskboards/{taskboardId}/tasks/{taskId}": { |
| 2987 | "patch": { |
| 2988 | "tags": ["Tasks"], |
| 2989 | "summary": "Update a task", |
| 2990 | "operationId": "updateTaskboardTask", |
| 2991 | "security": [{ "bearerAuth": [] }], |
| 2992 | "parameters": [ |
| 2993 | { |
| 2994 | "name": "workspaceSlug", |
| 2995 | "in": "path", |
| 2996 | "required": true, |
| 2997 | "schema": { "type": "string" } |
| 2998 | }, |
| 2999 | { |
| 3000 | "name": "taskboardId", |
| 3001 | "in": "path", |
| 3002 | "required": true, |
| 3003 | "schema": { "type": "string" } |
| 3004 | }, |
| 3005 | { |
| 3006 | "name": "taskId", |
| 3007 | "in": "path", |
| 3008 | "required": true, |
| 3009 | "schema": { "type": "string" } |
| 3010 | } |
| 3011 | ], |
| 3012 | "requestBody": { |
| 3013 | "required": true, |
| 3014 | "content": { |
| 3015 | "application/json": { |
| 3016 | "schema": { "$ref": "#/components/schemas/UpdateTaskInput" } |
| 3017 | } |
| 3018 | } |
| 3019 | }, |
| 3020 | "responses": { |
| 3021 | "200": { |
| 3022 | "description": "Task updated", |
| 3023 | "content": { |
| 3024 | "application/json": { |
| 3025 | "schema": { "$ref": "#/components/schemas/OkResponse" } |
| 3026 | } |
| 3027 | } |
| 3028 | }, |
| 3029 | "400": { |
| 3030 | "description": "Validation error", |
| 3031 | "content": { |
| 3032 | "application/json": { |
| 3033 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3034 | } |
| 3035 | } |
| 3036 | }, |
| 3037 | "404": { |
| 3038 | "description": "Task not found", |
| 3039 | "content": { |
| 3040 | "application/json": { |
| 3041 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3042 | } |
| 3043 | } |
| 3044 | } |
| 3045 | } |
| 3046 | }, |
| 3047 | "delete": { |
| 3048 | "tags": ["Tasks"], |
| 3049 | "summary": "Delete a task", |
| 3050 | "operationId": "deleteTaskboardTask", |
| 3051 | "security": [{ "bearerAuth": [] }], |
| 3052 | "parameters": [ |
| 3053 | { |
| 3054 | "name": "workspaceSlug", |
| 3055 | "in": "path", |
| 3056 | "required": true, |
| 3057 | "schema": { "type": "string" } |
| 3058 | }, |
| 3059 | { |
| 3060 | "name": "taskboardId", |
| 3061 | "in": "path", |
| 3062 | "required": true, |
| 3063 | "schema": { "type": "string" } |
| 3064 | }, |
| 3065 | { |
| 3066 | "name": "taskId", |
| 3067 | "in": "path", |
| 3068 | "required": true, |
| 3069 | "schema": { "type": "string" } |
| 3070 | } |
| 3071 | ], |
| 3072 | "responses": { |
| 3073 | "200": { |
| 3074 | "description": "Task deleted", |
| 3075 | "content": { |
| 3076 | "application/json": { |
| 3077 | "schema": { "$ref": "#/components/schemas/OkResponse" } |
| 3078 | } |
| 3079 | } |
| 3080 | }, |
| 3081 | "404": { |
| 3082 | "description": "Task not found", |
| 3083 | "content": { |
| 3084 | "application/json": { |
| 3085 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3086 | } |
| 3087 | } |
| 3088 | } |
| 3089 | } |
| 3090 | } |
| 3091 | }, |
| 3092 | "/api/v1/workspaces/{workspaceSlug}/channels": { |
| 3093 | "get": { |
| 3094 | "tags": ["Channels"], |
| 3095 | "operationId": "listWorkspaceChannels", |
| 3096 | "summary": "List channels", |
| 3097 | "description": "Returns all non-archived channels in the workspace. Only team workspaces have channels; personal workspaces return an empty array.", |
| 3098 | "security": [{ "bearerAuth": [] }], |
| 3099 | "parameters": [ |
| 3100 | { |
| 3101 | "name": "workspaceSlug", |
| 3102 | "in": "path", |
| 3103 | "required": true, |
| 3104 | "schema": { "type": "string" } |
| 3105 | } |
| 3106 | ], |
| 3107 | "responses": { |
| 3108 | "200": { |
| 3109 | "description": "Channel list", |
| 3110 | "content": { |
| 3111 | "application/json": { |
| 3112 | "schema": { "$ref": "#/components/schemas/ChannelListResponse" } |
| 3113 | } |
| 3114 | } |
| 3115 | } |
| 3116 | } |
| 3117 | } |
| 3118 | }, |
| 3119 | "/api/v1/workspaces/{workspaceSlug}/channels/{channelId}/messages": { |
| 3120 | "get": { |
| 3121 | "tags": ["Channels"], |
| 3122 | "operationId": "listChannelMessages", |
| 3123 | "summary": "List channel messages", |
| 3124 | "description": "Returns root-level messages in decreasing chronological order with cursor-based pagination.", |
| 3125 | "security": [{ "bearerAuth": [] }], |
| 3126 | "parameters": [ |
| 3127 | { |
| 3128 | "name": "workspaceSlug", |
| 3129 | "in": "path", |
| 3130 | "required": true, |
| 3131 | "schema": { "type": "string" } |
| 3132 | }, |
| 3133 | { |
| 3134 | "name": "channelId", |
| 3135 | "in": "path", |
| 3136 | "required": true, |
| 3137 | "schema": { "type": "string" } |
| 3138 | }, |
| 3139 | { |
| 3140 | "name": "limit", |
| 3141 | "in": "query", |
| 3142 | "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } |
| 3143 | }, |
| 3144 | { |
| 3145 | "name": "cursor", |
| 3146 | "in": "query", |
| 3147 | "schema": { "type": "string" }, |
| 3148 | "description": "Opaque pagination cursor returned in previous response." |
| 3149 | } |
| 3150 | ], |
| 3151 | "responses": { |
| 3152 | "200": { |
| 3153 | "description": "Paginated message list", |
| 3154 | "content": { |
| 3155 | "application/json": { |
| 3156 | "schema": { "$ref": "#/components/schemas/MessagesListResponse" } |
| 3157 | } |
| 3158 | } |
| 3159 | }, |
| 3160 | "404": { |
| 3161 | "description": "Channel not found", |
| 3162 | "content": { |
| 3163 | "application/json": { |
| 3164 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3165 | } |
| 3166 | } |
| 3167 | } |
| 3168 | } |
| 3169 | }, |
| 3170 | "post": { |
| 3171 | "tags": ["Channels"], |
| 3172 | "operationId": "sendChannelMessage", |
| 3173 | "summary": "Send a message to a channel", |
| 3174 | "description": "Sends a message to the specified channel. Requires user context (session auth).", |
| 3175 | "security": [{ "bearerAuth": [] }], |
| 3176 | "parameters": [ |
| 3177 | { |
| 3178 | "name": "workspaceSlug", |
| 3179 | "in": "path", |
| 3180 | "required": true, |
| 3181 | "schema": { "type": "string" } |
| 3182 | }, |
| 3183 | { |
| 3184 | "name": "channelId", |
| 3185 | "in": "path", |
| 3186 | "required": true, |
| 3187 | "schema": { "type": "string" } |
| 3188 | } |
| 3189 | ], |
| 3190 | "requestBody": { |
| 3191 | "required": true, |
| 3192 | "content": { |
| 3193 | "application/json": { |
| 3194 | "schema": { "$ref": "#/components/schemas/SendMessageInput" } |
| 3195 | } |
| 3196 | } |
| 3197 | }, |
| 3198 | "responses": { |
| 3199 | "201": { |
| 3200 | "description": "Message sent", |
| 3201 | "content": { |
| 3202 | "application/json": { |
| 3203 | "schema": { "$ref": "#/components/schemas/SendMessageResponse" } |
| 3204 | } |
| 3205 | } |
| 3206 | }, |
| 3207 | "404": { |
| 3208 | "description": "Channel not found", |
| 3209 | "content": { |
| 3210 | "application/json": { |
| 3211 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3212 | } |
| 3213 | } |
| 3214 | } |
| 3215 | } |
| 3216 | } |
| 3217 | }, |
| 3218 | "/api/v1/workspaces/{workspaceSlug}/dms": { |
| 3219 | "get": { |
| 3220 | "tags": ["Direct Messages"], |
| 3221 | "operationId": "listWorkspaceDms", |
| 3222 | "summary": "List direct messages", |
| 3223 | "description": "Returns workspace-scoped DM conversations with member details.", |
| 3224 | "security": [{ "bearerAuth": [] }], |
| 3225 | "parameters": [ |
| 3226 | { |
| 3227 | "name": "workspaceSlug", |
| 3228 | "in": "path", |
| 3229 | "required": true, |
| 3230 | "schema": { "type": "string" } |
| 3231 | } |
| 3232 | ], |
| 3233 | "responses": { |
| 3234 | "200": { |
| 3235 | "description": "DM list", |
| 3236 | "content": { |
| 3237 | "application/json": { |
| 3238 | "schema": { "$ref": "#/components/schemas/DmListResponse" } |
| 3239 | } |
| 3240 | } |
| 3241 | } |
| 3242 | } |
| 3243 | } |
| 3244 | }, |
| 3245 | "/api/v1/workspaces/{workspaceSlug}/dms/{dmId}/messages": { |
| 3246 | "get": { |
| 3247 | "tags": ["Direct Messages"], |
| 3248 | "operationId": "listDmMessages", |
| 3249 | "summary": "List DM messages", |
| 3250 | "description": "Returns root-level messages in a DM conversation in decreasing chronological order with cursor-based pagination.", |
| 3251 | "security": [{ "bearerAuth": [] }], |
| 3252 | "parameters": [ |
| 3253 | { |
| 3254 | "name": "workspaceSlug", |
| 3255 | "in": "path", |
| 3256 | "required": true, |
| 3257 | "schema": { "type": "string" } |
| 3258 | }, |
| 3259 | { |
| 3260 | "name": "dmId", |
| 3261 | "in": "path", |
| 3262 | "required": true, |
| 3263 | "schema": { "type": "string" } |
| 3264 | }, |
| 3265 | { |
| 3266 | "name": "limit", |
| 3267 | "in": "query", |
| 3268 | "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } |
| 3269 | }, |
| 3270 | { |
| 3271 | "name": "cursor", |
| 3272 | "in": "query", |
| 3273 | "schema": { "type": "string" }, |
| 3274 | "description": "Opaque pagination cursor returned in previous response." |
| 3275 | } |
| 3276 | ], |
| 3277 | "responses": { |
| 3278 | "200": { |
| 3279 | "description": "Paginated message list", |
| 3280 | "content": { |
| 3281 | "application/json": { |
| 3282 | "schema": { "$ref": "#/components/schemas/MessagesListResponse" } |
| 3283 | } |
| 3284 | } |
| 3285 | }, |
| 3286 | "404": { |
| 3287 | "description": "DM not found", |
| 3288 | "content": { |
| 3289 | "application/json": { |
| 3290 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3291 | } |
| 3292 | } |
| 3293 | } |
| 3294 | } |
| 3295 | }, |
| 3296 | "post": { |
| 3297 | "tags": ["Direct Messages"], |
| 3298 | "operationId": "sendDmMessage", |
| 3299 | "summary": "Send a message to a DM", |
| 3300 | "description": "Sends a message in a DM conversation. Requires user context (session auth).", |
| 3301 | "security": [{ "bearerAuth": [] }], |
| 3302 | "parameters": [ |
| 3303 | { |
| 3304 | "name": "workspaceSlug", |
| 3305 | "in": "path", |
| 3306 | "required": true, |
| 3307 | "schema": { "type": "string" } |
| 3308 | }, |
| 3309 | { |
| 3310 | "name": "dmId", |
| 3311 | "in": "path", |
| 3312 | "required": true, |
| 3313 | "schema": { "type": "string" } |
| 3314 | } |
| 3315 | ], |
| 3316 | "requestBody": { |
| 3317 | "required": true, |
| 3318 | "content": { |
| 3319 | "application/json": { |
| 3320 | "schema": { "$ref": "#/components/schemas/SendMessageInput" } |
| 3321 | } |
| 3322 | } |
| 3323 | }, |
| 3324 | "responses": { |
| 3325 | "201": { |
| 3326 | "description": "Message sent", |
| 3327 | "content": { |
| 3328 | "application/json": { |
| 3329 | "schema": { "$ref": "#/components/schemas/SendMessageResponse" } |
| 3330 | } |
| 3331 | } |
| 3332 | }, |
| 3333 | "404": { |
| 3334 | "description": "DM not found", |
| 3335 | "content": { |
| 3336 | "application/json": { |
| 3337 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3338 | } |
| 3339 | } |
| 3340 | } |
| 3341 | } |
| 3342 | } |
| 3343 | }, |
| 3344 | "/api/v1/workspaces/{workspaceSlug}/messages/{messageId}": { |
| 3345 | "get": { |
| 3346 | "tags": ["Messages"], |
| 3347 | "operationId": "getMessage", |
| 3348 | "summary": "Get a message", |
| 3349 | "description": "Retrieves a single message by ID, including container context.", |
| 3350 | "security": [{ "bearerAuth": [] }], |
| 3351 | "parameters": [ |
| 3352 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3353 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } |
| 3354 | ], |
| 3355 | "responses": { |
| 3356 | "200": { |
| 3357 | "description": "Message detail", |
| 3358 | "content": { |
| 3359 | "application/json": { |
| 3360 | "schema": { "$ref": "#/components/schemas/MessageDetailResponse" } |
| 3361 | } |
| 3362 | } |
| 3363 | }, |
| 3364 | "404": { |
| 3365 | "description": "Message not found", |
| 3366 | "content": { |
| 3367 | "application/json": { |
| 3368 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3369 | } |
| 3370 | } |
| 3371 | } |
| 3372 | } |
| 3373 | }, |
| 3374 | "patch": { |
| 3375 | "tags": ["Messages"], |
| 3376 | "operationId": "editMessage", |
| 3377 | "summary": "Edit a message", |
| 3378 | "description": "Updates the content of a message. Only the author can edit.", |
| 3379 | "security": [{ "bearerAuth": [] }], |
| 3380 | "parameters": [ |
| 3381 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3382 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } |
| 3383 | ], |
| 3384 | "requestBody": { |
| 3385 | "required": true, |
| 3386 | "content": { |
| 3387 | "application/json": { |
| 3388 | "schema": { "$ref": "#/components/schemas/EditMessageInput" } |
| 3389 | } |
| 3390 | } |
| 3391 | }, |
| 3392 | "responses": { |
| 3393 | "200": { |
| 3394 | "description": "Updated message", |
| 3395 | "content": { |
| 3396 | "application/json": { |
| 3397 | "schema": { "$ref": "#/components/schemas/MessageDetailResponse" } |
| 3398 | } |
| 3399 | } |
| 3400 | }, |
| 3401 | "403": { |
| 3402 | "description": "Not the message author", |
| 3403 | "content": { |
| 3404 | "application/json": { |
| 3405 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3406 | } |
| 3407 | } |
| 3408 | }, |
| 3409 | "404": { |
| 3410 | "description": "Message not found", |
| 3411 | "content": { |
| 3412 | "application/json": { |
| 3413 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3414 | } |
| 3415 | } |
| 3416 | } |
| 3417 | } |
| 3418 | }, |
| 3419 | "delete": { |
| 3420 | "tags": ["Messages"], |
| 3421 | "operationId": "deleteMessage", |
| 3422 | "summary": "Delete a message", |
| 3423 | "description": "Soft-deletes a message. Only the author can delete.", |
| 3424 | "security": [{ "bearerAuth": [] }], |
| 3425 | "parameters": [ |
| 3426 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3427 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } |
| 3428 | ], |
| 3429 | "responses": { |
| 3430 | "200": { |
| 3431 | "description": "Message deleted", |
| 3432 | "content": { |
| 3433 | "application/json": { |
| 3434 | "schema": { "$ref": "#/components/schemas/OkResponse" } |
| 3435 | } |
| 3436 | } |
| 3437 | }, |
| 3438 | "403": { |
| 3439 | "description": "Not the message author", |
| 3440 | "content": { |
| 3441 | "application/json": { |
| 3442 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3443 | } |
| 3444 | } |
| 3445 | }, |
| 3446 | "404": { |
| 3447 | "description": "Message not found", |
| 3448 | "content": { |
| 3449 | "application/json": { |
| 3450 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3451 | } |
| 3452 | } |
| 3453 | } |
| 3454 | } |
| 3455 | } |
| 3456 | }, |
| 3457 | "/api/v1/workspaces/{workspaceSlug}/messages/{messageId}/thread": { |
| 3458 | "get": { |
| 3459 | "tags": ["Messages"], |
| 3460 | "operationId": "getThread", |
| 3461 | "summary": "Get thread replies", |
| 3462 | "description": "Returns the root message and up to 200 thread replies in ascending chronological order.", |
| 3463 | "security": [{ "bearerAuth": [] }], |
| 3464 | "parameters": [ |
| 3465 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3466 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } |
| 3467 | ], |
| 3468 | "responses": { |
| 3469 | "200": { |
| 3470 | "description": "Thread with root message and replies", |
| 3471 | "content": { |
| 3472 | "application/json": { |
| 3473 | "schema": { "$ref": "#/components/schemas/ThreadResponse" } |
| 3474 | } |
| 3475 | } |
| 3476 | }, |
| 3477 | "404": { |
| 3478 | "description": "Message not found", |
| 3479 | "content": { |
| 3480 | "application/json": { |
| 3481 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3482 | } |
| 3483 | } |
| 3484 | } |
| 3485 | } |
| 3486 | }, |
| 3487 | "post": { |
| 3488 | "tags": ["Messages"], |
| 3489 | "operationId": "replyToThread", |
| 3490 | "summary": "Reply to a thread", |
| 3491 | "description": "Posts a reply to a message thread. Requires user context.", |
| 3492 | "security": [{ "bearerAuth": [] }], |
| 3493 | "parameters": [ |
| 3494 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3495 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } |
| 3496 | ], |
| 3497 | "requestBody": { |
| 3498 | "required": true, |
| 3499 | "content": { |
| 3500 | "application/json": { |
| 3501 | "schema": { "$ref": "#/components/schemas/ThreadReplyInput" } |
| 3502 | } |
| 3503 | } |
| 3504 | }, |
| 3505 | "responses": { |
| 3506 | "201": { |
| 3507 | "description": "Reply posted", |
| 3508 | "content": { |
| 3509 | "application/json": { |
| 3510 | "schema": { "$ref": "#/components/schemas/SendMessageResponse" } |
| 3511 | } |
| 3512 | } |
| 3513 | }, |
| 3514 | "404": { |
| 3515 | "description": "Message not found", |
| 3516 | "content": { |
| 3517 | "application/json": { |
| 3518 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3519 | } |
| 3520 | } |
| 3521 | } |
| 3522 | } |
| 3523 | } |
| 3524 | }, |
| 3525 | "/api/v1/workspaces/{workspaceSlug}/messages/{messageId}/reactions/{emoji}": { |
| 3526 | "put": { |
| 3527 | "tags": ["Messages"], |
| 3528 | "operationId": "addReaction", |
| 3529 | "summary": "Add a reaction", |
| 3530 | "description": "Adds an emoji reaction to a message. Idempotent.", |
| 3531 | "security": [{ "bearerAuth": [] }], |
| 3532 | "parameters": [ |
| 3533 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3534 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3535 | { "name": "emoji", "in": "path", "required": true, "schema": { "type": "string" }, "description": "URL-encoded emoji character." } |
| 3536 | ], |
| 3537 | "responses": { |
| 3538 | "200": { |
| 3539 | "description": "Reaction applied", |
| 3540 | "content": { |
| 3541 | "application/json": { |
| 3542 | "schema": { "$ref": "#/components/schemas/ReactionResponse" } |
| 3543 | } |
| 3544 | } |
| 3545 | }, |
| 3546 | "404": { |
| 3547 | "description": "Message not found", |
| 3548 | "content": { |
| 3549 | "application/json": { |
| 3550 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3551 | } |
| 3552 | } |
| 3553 | } |
| 3554 | } |
| 3555 | }, |
| 3556 | "delete": { |
| 3557 | "tags": ["Messages"], |
| 3558 | "operationId": "removeReaction", |
| 3559 | "summary": "Remove a reaction", |
| 3560 | "description": "Removes a specific emoji reaction from a message.", |
| 3561 | "security": [{ "bearerAuth": [] }], |
| 3562 | "parameters": [ |
| 3563 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3564 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3565 | { "name": "emoji", "in": "path", "required": true, "schema": { "type": "string" }, "description": "URL-encoded emoji character." } |
| 3566 | ], |
| 3567 | "responses": { |
| 3568 | "200": { |
| 3569 | "description": "Reaction removed", |
| 3570 | "content": { |
| 3571 | "application/json": { |
| 3572 | "schema": { "$ref": "#/components/schemas/OkResponse" } |
| 3573 | } |
| 3574 | } |
| 3575 | }, |
| 3576 | "404": { |
| 3577 | "description": "Message not found", |
| 3578 | "content": { |
| 3579 | "application/json": { |
| 3580 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3581 | } |
| 3582 | } |
| 3583 | } |
| 3584 | } |
| 3585 | } |
| 3586 | }, |
| 3587 | "/api/v1/workspaces/{workspaceSlug}/messages/{messageId}/pin": { |
| 3588 | "put": { |
| 3589 | "tags": ["Messages"], |
| 3590 | "operationId": "pinMessage", |
| 3591 | "summary": "Pin a message", |
| 3592 | "description": "Pins a message in its container. Idempotent.", |
| 3593 | "security": [{ "bearerAuth": [] }], |
| 3594 | "parameters": [ |
| 3595 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3596 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } |
| 3597 | ], |
| 3598 | "responses": { |
| 3599 | "200": { |
| 3600 | "description": "Message pinned", |
| 3601 | "content": { |
| 3602 | "application/json": { |
| 3603 | "schema": { "$ref": "#/components/schemas/PinResponse" } |
| 3604 | } |
| 3605 | } |
| 3606 | }, |
| 3607 | "404": { |
| 3608 | "description": "Message not found", |
| 3609 | "content": { |
| 3610 | "application/json": { |
| 3611 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3612 | } |
| 3613 | } |
| 3614 | } |
| 3615 | } |
| 3616 | }, |
| 3617 | "delete": { |
| 3618 | "tags": ["Messages"], |
| 3619 | "operationId": "unpinMessage", |
| 3620 | "summary": "Unpin a message", |
| 3621 | "description": "Removes a pin from a message.", |
| 3622 | "security": [{ "bearerAuth": [] }], |
| 3623 | "parameters": [ |
| 3624 | { "name": "workspaceSlug", "in": "path", "required": true, "schema": { "type": "string" } }, |
| 3625 | { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } |
| 3626 | ], |
| 3627 | "responses": { |
| 3628 | "200": { |
| 3629 | "description": "Message unpinned", |
| 3630 | "content": { |
| 3631 | "application/json": { |
| 3632 | "schema": { "$ref": "#/components/schemas/PinResponse" } |
| 3633 | } |
| 3634 | } |
| 3635 | }, |
| 3636 | "404": { |
| 3637 | "description": "Message not found", |
| 3638 | "content": { |
| 3639 | "application/json": { |
| 3640 | "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } |
| 3641 | } |
| 3642 | } |
| 3643 | } |
| 3644 | } |
| 3645 | } |
| 3646 | } |
| 3647 | }, |
| 3648 | "components": { |
| 3649 | "securitySchemes": { |
| 3650 | "bearerAuth": { |
| 3651 | "type": "http", |
| 3652 | "scheme": "bearer", |
| 3653 | "bearerFormat": "API key or session-backed bearer token" |
| 3654 | } |
| 3655 | }, |
| 3656 | "schemas": { |
| 3657 | "ErrorEnvelope": { |
| 3658 | "type": "object", |
| 3659 | "required": [ |
| 3660 | "error" |
| 3661 | ], |
| 3662 | "properties": { |
| 3663 | "error": { |
| 3664 | "type": "object", |
| 3665 | "required": [ |
| 3666 | "code", |
| 3667 | "message" |
| 3668 | ], |
| 3669 | "properties": { |
| 3670 | "code": { |
| 3671 | "type": "string" |
| 3672 | }, |
| 3673 | "message": { |
| 3674 | "type": "string" |
| 3675 | } |
| 3676 | } |
| 3677 | } |
| 3678 | } |
| 3679 | }, |
| 3680 | "OAuthErrorResponse": { |
| 3681 | "type": "object", |
| 3682 | "required": [ |
| 3683 | "error", |
| 3684 | "error_description" |
| 3685 | ], |
| 3686 | "properties": { |
| 3687 | "error": { |
| 3688 | "type": "string" |
| 3689 | }, |
| 3690 | "error_description": { |
| 3691 | "type": "string" |
| 3692 | } |
| 3693 | } |
| 3694 | }, |
| 3695 | "OAuthTokenExchangeInput": { |
| 3696 | "type": "object", |
| 3697 | "required": [ |
| 3698 | "grant_type", |
| 3699 | "client_id", |
| 3700 | "client_secret", |
| 3701 | "code", |
| 3702 | "redirect_uri" |
| 3703 | ], |
| 3704 | "properties": { |
| 3705 | "grant_type": { |
| 3706 | "type": "string", |
| 3707 | "const": "authorization_code" |
| 3708 | }, |
| 3709 | "client_id": { |
| 3710 | "type": "string" |
| 3711 | }, |
| 3712 | "client_secret": { |
| 3713 | "type": "string" |
| 3714 | }, |
| 3715 | "code": { |
| 3716 | "type": "string" |
| 3717 | }, |
| 3718 | "redirect_uri": { |
| 3719 | "type": "string", |
| 3720 | "format": "uri" |
| 3721 | }, |
| 3722 | "code_verifier": { |
| 3723 | "type": "string" |
| 3724 | } |
| 3725 | } |
| 3726 | }, |
| 3727 | "OAuthTokenResponse": { |
| 3728 | "type": "object", |
| 3729 | "required": [ |
| 3730 | "access_token", |
| 3731 | "token_type", |
| 3732 | "expires_in", |
| 3733 | "refresh_token", |
| 3734 | "scope" |
| 3735 | ], |
| 3736 | "properties": { |
| 3737 | "access_token": { |
| 3738 | "type": "string" |
| 3739 | }, |
| 3740 | "token_type": { |
| 3741 | "type": "string", |
| 3742 | "const": "Bearer" |
| 3743 | }, |
| 3744 | "expires_in": { |
| 3745 | "type": "integer" |
| 3746 | }, |
| 3747 | "refresh_token": { |
| 3748 | "type": "string" |
| 3749 | }, |
| 3750 | "scope": { |
| 3751 | "type": "string" |
| 3752 | } |
| 3753 | } |
| 3754 | }, |
| 3755 | "OAuthUserInfoResponse": { |
| 3756 | "type": "object", |
| 3757 | "required": [ |
| 3758 | "sub", |
| 3759 | "email", |
| 3760 | "email_verified", |
| 3761 | "name", |
| 3762 | "given_name", |
| 3763 | "family_name", |
| 3764 | "picture", |
| 3765 | "preferred_username", |
| 3766 | "scope" |
| 3767 | ], |
| 3768 | "properties": { |
| 3769 | "sub": { |
| 3770 | "type": "string" |
| 3771 | }, |
| 3772 | "email": { |
| 3773 | "type": "string" |
| 3774 | }, |
| 3775 | "email_verified": { |
| 3776 | "type": "boolean" |
| 3777 | }, |
| 3778 | "name": { |
| 3779 | "type": "string" |
| 3780 | }, |
| 3781 | "given_name": { |
| 3782 | "type": [ |
| 3783 | "string", |
| 3784 | "null" |
| 3785 | ] |
| 3786 | }, |
| 3787 | "family_name": { |
| 3788 | "type": [ |
| 3789 | "string", |
| 3790 | "null" |
| 3791 | ] |
| 3792 | }, |
| 3793 | "picture": { |
| 3794 | "type": [ |
| 3795 | "string", |
| 3796 | "null" |
| 3797 | ] |
| 3798 | }, |
| 3799 | "preferred_username": { |
| 3800 | "type": [ |
| 3801 | "string", |
| 3802 | "null" |
| 3803 | ] |
| 3804 | }, |
| 3805 | "scope": { |
| 3806 | "type": "string" |
| 3807 | } |
| 3808 | } |
| 3809 | }, |
| 3810 | "TabModelRecord": { |
| 3811 | "type": "object", |
| 3812 | "required": [ |
| 3813 | "id", |
| 3814 | "object", |
| 3815 | "created", |
| 3816 | "owned_by", |
| 3817 | "providerModelId", |
| 3818 | "pricing", |
| 3819 | "capabilities" |
| 3820 | ], |
| 3821 | "properties": { |
| 3822 | "id": { |
| 3823 | "type": "string" |
| 3824 | }, |
| 3825 | "object": { |
| 3826 | "type": "string", |
| 3827 | "const": "model" |
| 3828 | }, |
| 3829 | "created": { |
| 3830 | "type": "integer" |
| 3831 | }, |
| 3832 | "owned_by": { |
| 3833 | "type": "string" |
| 3834 | }, |
| 3835 | "providerModelId": { |
| 3836 | "type": "string" |
| 3837 | }, |
| 3838 | "pricing": { |
| 3839 | "type": "object", |
| 3840 | "required": [ |
| 3841 | "inputPerMillionUsd", |
| 3842 | "outputPerMillionUsd" |
| 3843 | ], |
| 3844 | "properties": { |
| 3845 | "inputPerMillionUsd": { |
| 3846 | "type": "number" |
| 3847 | }, |
| 3848 | "outputPerMillionUsd": { |
| 3849 | "type": "number" |
| 3850 | } |
| 3851 | } |
| 3852 | }, |
| 3853 | "capabilities": { |
| 3854 | "type": "object", |
| 3855 | "required": [ |
| 3856 | "streaming", |
| 3857 | "surfaces" |
| 3858 | ], |
| 3859 | "properties": { |
| 3860 | "streaming": { |
| 3861 | "type": "boolean" |
| 3862 | }, |
| 3863 | "surfaces": { |
| 3864 | "type": "array", |
| 3865 | "items": { |
| 3866 | "type": "string" |
| 3867 | } |
| 3868 | } |
| 3869 | } |
| 3870 | } |
| 3871 | } |
| 3872 | }, |
| 3873 | "TabModelsResponse": { |
| 3874 | "type": "object", |
| 3875 | "required": [ |
| 3876 | "data" |
| 3877 | ], |
| 3878 | "properties": { |
| 3879 | "data": { |
| 3880 | "type": "object", |
| 3881 | "required": [ |
| 3882 | "object", |
| 3883 | "data" |
| 3884 | ], |
| 3885 | "properties": { |
| 3886 | "object": { |
| 3887 | "type": "string", |
| 3888 | "const": "list" |
| 3889 | }, |
| 3890 | "data": { |
| 3891 | "type": "array", |
| 3892 | "items": { |
| 3893 | "$ref": "#/components/schemas/TabModelRecord" |
| 3894 | } |
| 3895 | } |
| 3896 | } |
| 3897 | } |
| 3898 | } |
| 3899 | }, |
| 3900 | "TabChatCompletionInput": { |
| 3901 | "type": "object", |
| 3902 | "required": [ |
| 3903 | "model", |
| 3904 | "tab_context" |
| 3905 | ], |
| 3906 | "properties": { |
| 3907 | "model": { |
| 3908 | "type": "string" |
| 3909 | }, |
| 3910 | "messages": { |
| 3911 | "type": "array", |
| 3912 | "items": { |
| 3913 | "type": "object", |
| 3914 | "properties": { |
| 3915 | "role": { |
| 3916 | "type": "string" |
| 3917 | }, |
| 3918 | "content": { |
| 3919 | "type": "string" |
| 3920 | } |
| 3921 | } |
| 3922 | } |
| 3923 | }, |
| 3924 | "stream": { |
| 3925 | "type": "boolean" |
| 3926 | }, |
| 3927 | "max_tokens": { |
| 3928 | "type": "integer" |
| 3929 | }, |
| 3930 | "max_completion_tokens": { |
| 3931 | "type": "integer" |
| 3932 | }, |
| 3933 | "temperature": { |
| 3934 | "type": "number" |
| 3935 | }, |
| 3936 | "top_p": { |
| 3937 | "type": "number" |
| 3938 | }, |
| 3939 | "tab_context": { |
| 3940 | "type": "object", |
| 3941 | "additionalProperties": true |
| 3942 | } |
| 3943 | } |
| 3944 | }, |
| 3945 | "TabChatCompletionResponseEnvelope": { |
| 3946 | "type": "object", |
| 3947 | "required": [ |
| 3948 | "data" |
| 3949 | ], |
| 3950 | "properties": { |
| 3951 | "data": { |
| 3952 | "type": "object", |
| 3953 | "required": [ |
| 3954 | "id", |
| 3955 | "object", |
| 3956 | "created", |
| 3957 | "model", |
| 3958 | "choices", |
| 3959 | "usage" |
| 3960 | ], |
| 3961 | "properties": { |
| 3962 | "id": { |
| 3963 | "type": "string" |
| 3964 | }, |
| 3965 | "object": { |
| 3966 | "type": "string", |
| 3967 | "const": "chat.completion" |
| 3968 | }, |
| 3969 | "created": { |
| 3970 | "type": "integer" |
| 3971 | }, |
| 3972 | "model": { |
| 3973 | "type": "string" |
| 3974 | }, |
| 3975 | "choices": { |
| 3976 | "type": "array", |
| 3977 | "items": { |
| 3978 | "type": "object", |
| 3979 | "required": [ |
| 3980 | "index", |
| 3981 | "message", |
| 3982 | "finish_reason" |
| 3983 | ], |
| 3984 | "properties": { |
| 3985 | "index": { |
| 3986 | "type": "integer" |
| 3987 | }, |
| 3988 | "message": { |
| 3989 | "type": "object", |
| 3990 | "required": [ |
| 3991 | "role", |
| 3992 | "content" |
| 3993 | ], |
| 3994 | "properties": { |
| 3995 | "role": { |
| 3996 | "type": "string", |
| 3997 | "const": "assistant" |
| 3998 | }, |
| 3999 | "content": { |
| 4000 | "type": "string" |
| 4001 | } |
| 4002 | } |
| 4003 | }, |
| 4004 | "finish_reason": { |
| 4005 | "type": "string", |
| 4006 | "const": "stop" |
| 4007 | } |
| 4008 | } |
| 4009 | } |
| 4010 | }, |
| 4011 | "usage": { |
| 4012 | "type": "object", |
| 4013 | "required": [ |
| 4014 | "prompt_tokens", |
| 4015 | "completion_tokens", |
| 4016 | "total_tokens" |
| 4017 | ], |
| 4018 | "properties": { |
| 4019 | "prompt_tokens": { |
| 4020 | "type": "integer" |
| 4021 | }, |
| 4022 | "completion_tokens": { |
| 4023 | "type": "integer" |
| 4024 | }, |
| 4025 | "total_tokens": { |
| 4026 | "type": "integer" |
| 4027 | } |
| 4028 | } |
| 4029 | } |
| 4030 | } |
| 4031 | } |
| 4032 | } |
| 4033 | }, |
| 4034 | "OkResponse": { |
| 4035 | "type": "object", |
| 4036 | "required": [ |
| 4037 | "data" |
| 4038 | ], |
| 4039 | "properties": { |
| 4040 | "data": { |
| 4041 | "type": "object", |
| 4042 | "required": [ |
| 4043 | "ok" |
| 4044 | ], |
| 4045 | "properties": { |
| 4046 | "ok": { |
| 4047 | "type": "boolean", |
| 4048 | "const": true |
| 4049 | } |
| 4050 | } |
| 4051 | } |
| 4052 | } |
| 4053 | }, |
| 4054 | "AppCatalogItem": { |
| 4055 | "type": "object", |
| 4056 | "required": [ |
| 4057 | "appId", |
| 4058 | "appKey", |
| 4059 | "name", |
| 4060 | "description", |
| 4061 | "iconUrl", |
| 4062 | "status", |
| 4063 | "latestPublishedVersion", |
| 4064 | "latestPublishedVersionId", |
| 4065 | "isInstalled" |
| 4066 | ], |
| 4067 | "properties": { |
| 4068 | "appId": { |
| 4069 | "type": "string" |
| 4070 | }, |
| 4071 | "appKey": { |
| 4072 | "type": "string" |
| 4073 | }, |
| 4074 | "name": { |
| 4075 | "type": "string" |
| 4076 | }, |
| 4077 | "description": { |
| 4078 | "type": [ |
| 4079 | "string", |
| 4080 | "null" |
| 4081 | ] |
| 4082 | }, |
| 4083 | "iconUrl": { |
| 4084 | "type": [ |
| 4085 | "string", |
| 4086 | "null" |
| 4087 | ] |
| 4088 | }, |
| 4089 | "status": { |
| 4090 | "type": "string" |
| 4091 | }, |
| 4092 | "latestPublishedVersion": { |
| 4093 | "type": [ |
| 4094 | "string", |
| 4095 | "null" |
| 4096 | ] |
| 4097 | }, |
| 4098 | "latestPublishedVersionId": { |
| 4099 | "type": [ |
| 4100 | "string", |
| 4101 | "null" |
| 4102 | ] |
| 4103 | }, |
| 4104 | "isInstalled": { |
| 4105 | "type": "boolean" |
| 4106 | } |
| 4107 | } |
| 4108 | }, |
| 4109 | "RegisteredAppDetail": { |
| 4110 | "type": "object", |
| 4111 | "required": [ |
| 4112 | "appId", |
| 4113 | "appKey", |
| 4114 | "name", |
| 4115 | "description", |
| 4116 | "iconUrl", |
| 4117 | "status", |
| 4118 | "ownerUserId", |
| 4119 | "storeListed", |
| 4120 | "latestPublishedVersion", |
| 4121 | "latestPublishedVersionId" |
| 4122 | ], |
| 4123 | "properties": { |
| 4124 | "appId": { |
| 4125 | "type": "string" |
| 4126 | }, |
| 4127 | "appKey": { |
| 4128 | "type": "string" |
| 4129 | }, |
| 4130 | "name": { |
| 4131 | "type": "string" |
| 4132 | }, |
| 4133 | "description": { |
| 4134 | "type": [ |
| 4135 | "string", |
| 4136 | "null" |
| 4137 | ] |
| 4138 | }, |
| 4139 | "iconUrl": { |
| 4140 | "type": [ |
| 4141 | "string", |
| 4142 | "null" |
| 4143 | ] |
| 4144 | }, |
| 4145 | "status": { |
| 4146 | "type": "string" |
| 4147 | }, |
| 4148 | "ownerUserId": { |
| 4149 | "type": [ |
| 4150 | "string", |
| 4151 | "null" |
| 4152 | ] |
| 4153 | }, |
| 4154 | "storeListed": { |
| 4155 | "type": "boolean" |
| 4156 | }, |
| 4157 | "latestPublishedVersion": { |
| 4158 | "type": [ |
| 4159 | "string", |
| 4160 | "null" |
| 4161 | ] |
| 4162 | }, |
| 4163 | "latestPublishedVersionId": { |
| 4164 | "type": [ |
| 4165 | "string", |
| 4166 | "null" |
| 4167 | ] |
| 4168 | } |
| 4169 | } |
| 4170 | }, |
| 4171 | "RegisteredAppVersionSummary": { |
| 4172 | "type": "object", |
| 4173 | "required": [ |
| 4174 | "versionId", |
| 4175 | "version", |
| 4176 | "status", |
| 4177 | "reviewStatus", |
| 4178 | "apiBaseUrl", |
| 4179 | "permissions", |
| 4180 | "notificationChannels", |
| 4181 | "kairo", |
| 4182 | "fileTypes", |
| 4183 | "submittedAt", |
| 4184 | "reviewedAt", |
| 4185 | "reviewNotes", |
| 4186 | "publishedAt", |
| 4187 | "createdAt", |
| 4188 | "updatedAt" |
| 4189 | ], |
| 4190 | "properties": { |
| 4191 | "versionId": { |
| 4192 | "type": "string" |
| 4193 | }, |
| 4194 | "version": { |
| 4195 | "type": "string" |
| 4196 | }, |
| 4197 | "status": { |
| 4198 | "type": "string" |
| 4199 | }, |
| 4200 | "reviewStatus": { |
| 4201 | "type": "string" |
| 4202 | }, |
| 4203 | "apiBaseUrl": { |
| 4204 | "type": "string" |
| 4205 | }, |
| 4206 | "permissions": { |
| 4207 | "type": "array", |
| 4208 | "items": { |
| 4209 | "type": "string" |
| 4210 | } |
| 4211 | }, |
| 4212 | "notificationChannels": { |
| 4213 | "type": "array", |
| 4214 | "items": { |
| 4215 | "type": "object", |
| 4216 | "required": [ |
| 4217 | "key", |
| 4218 | "name", |
| 4219 | "defaultDeliveries", |
| 4220 | "defaultPriority" |
| 4221 | ], |
| 4222 | "properties": { |
| 4223 | "key": { |
| 4224 | "type": "string" |
| 4225 | }, |
| 4226 | "name": { |
| 4227 | "type": "string" |
| 4228 | }, |
| 4229 | "description": { |
| 4230 | "type": "string" |
| 4231 | }, |
| 4232 | "defaultDeliveries": { |
| 4233 | "type": "array", |
| 4234 | "items": { |
| 4235 | "type": "string" |
| 4236 | } |
| 4237 | }, |
| 4238 | "defaultPriority": { |
| 4239 | "type": "string" |
| 4240 | } |
| 4241 | } |
| 4242 | } |
| 4243 | }, |
| 4244 | "kairo": { |
| 4245 | "oneOf": [ |
| 4246 | { |
| 4247 | "type": "object", |
| 4248 | "additionalProperties": true |
| 4249 | }, |
| 4250 | { |
| 4251 | "type": "null" |
| 4252 | } |
| 4253 | ] |
| 4254 | }, |
| 4255 | "fileTypes": { |
| 4256 | "type": "array", |
| 4257 | "items": { |
| 4258 | "type": "object", |
| 4259 | "required": [ |
| 4260 | "typeKey", |
| 4261 | "name", |
| 4262 | "description" |
| 4263 | ], |
| 4264 | "properties": { |
| 4265 | "typeKey": { |
| 4266 | "type": "string" |
| 4267 | }, |
| 4268 | "name": { |
| 4269 | "type": "string" |
| 4270 | }, |
| 4271 | "description": { |
| 4272 | "type": [ |
| 4273 | "string", |
| 4274 | "null" |
| 4275 | ] |
| 4276 | } |
| 4277 | } |
| 4278 | } |
| 4279 | }, |
| 4280 | "submittedAt": { |
| 4281 | "type": [ |
| 4282 | "string", |
| 4283 | "null" |
| 4284 | ], |
| 4285 | "format": "date-time" |
| 4286 | }, |
| 4287 | "reviewedAt": { |
| 4288 | "type": [ |
| 4289 | "string", |
| 4290 | "null" |
| 4291 | ], |
| 4292 | "format": "date-time" |
| 4293 | }, |
| 4294 | "reviewNotes": { |
| 4295 | "type": [ |
| 4296 | "string", |
| 4297 | "null" |
| 4298 | ] |
| 4299 | }, |
| 4300 | "publishedAt": { |
| 4301 | "type": [ |
| 4302 | "string", |
| 4303 | "null" |
| 4304 | ], |
| 4305 | "format": "date-time" |
| 4306 | }, |
| 4307 | "createdAt": { |
| 4308 | "type": "string", |
| 4309 | "format": "date-time" |
| 4310 | }, |
| 4311 | "updatedAt": { |
| 4312 | "type": "string", |
| 4313 | "format": "date-time" |
| 4314 | } |
| 4315 | } |
| 4316 | }, |
| 4317 | "InstalledAppSummary": { |
| 4318 | "type": "object", |
| 4319 | "required": [ |
| 4320 | "installId", |
| 4321 | "appId", |
| 4322 | "appKey", |
| 4323 | "name", |
| 4324 | "description", |
| 4325 | "iconUrl", |
| 4326 | "status", |
| 4327 | "installScope", |
| 4328 | "scopeSubjectId", |
| 4329 | "version" |
| 4330 | ], |
| 4331 | "properties": { |
| 4332 | "installId": { |
| 4333 | "type": "string" |
| 4334 | }, |
| 4335 | "appId": { |
| 4336 | "type": "string" |
| 4337 | }, |
| 4338 | "appKey": { |
| 4339 | "type": "string" |
| 4340 | }, |
| 4341 | "name": { |
| 4342 | "type": "string" |
| 4343 | }, |
| 4344 | "description": { |
| 4345 | "type": [ |
| 4346 | "string", |
| 4347 | "null" |
| 4348 | ] |
| 4349 | }, |
| 4350 | "iconUrl": { |
| 4351 | "type": [ |
| 4352 | "string", |
| 4353 | "null" |
| 4354 | ] |
| 4355 | }, |
| 4356 | "status": { |
| 4357 | "type": "string" |
| 4358 | }, |
| 4359 | "installScope": { |
| 4360 | "type": "string" |
| 4361 | }, |
| 4362 | "scopeSubjectId": { |
| 4363 | "type": "string" |
| 4364 | }, |
| 4365 | "version": { |
| 4366 | "type": [ |
| 4367 | "string", |
| 4368 | "null" |
| 4369 | ] |
| 4370 | } |
| 4371 | } |
| 4372 | }, |
| 4373 | "StoreAppsResponse": { |
| 4374 | "type": "object", |
| 4375 | "required": [ |
| 4376 | "data" |
| 4377 | ], |
| 4378 | "properties": { |
| 4379 | "data": { |
| 4380 | "type": "object", |
| 4381 | "required": [ |
| 4382 | "apps" |
| 4383 | ], |
| 4384 | "properties": { |
| 4385 | "apps": { |
| 4386 | "type": "array", |
| 4387 | "items": { |
| 4388 | "$ref": "#/components/schemas/RegisteredAppDetail" |
| 4389 | } |
| 4390 | } |
| 4391 | } |
| 4392 | } |
| 4393 | } |
| 4394 | }, |
| 4395 | "StoreAppResponse": { |
| 4396 | "type": "object", |
| 4397 | "required": [ |
| 4398 | "data" |
| 4399 | ], |
| 4400 | "properties": { |
| 4401 | "data": { |
| 4402 | "type": "object", |
| 4403 | "required": [ |
| 4404 | "app" |
| 4405 | ], |
| 4406 | "properties": { |
| 4407 | "app": { |
| 4408 | "$ref": "#/components/schemas/RegisteredAppDetail" |
| 4409 | } |
| 4410 | } |
| 4411 | } |
| 4412 | } |
| 4413 | }, |
| 4414 | "StoreAppVersionsResponse": { |
| 4415 | "type": "object", |
| 4416 | "required": [ |
| 4417 | "data" |
| 4418 | ], |
| 4419 | "properties": { |
| 4420 | "data": { |
| 4421 | "type": "object", |
| 4422 | "required": [ |
| 4423 | "versions" |
| 4424 | ], |
| 4425 | "properties": { |
| 4426 | "versions": { |
| 4427 | "type": "array", |
| 4428 | "items": { |
| 4429 | "$ref": "#/components/schemas/RegisteredAppVersionSummary" |
| 4430 | } |
| 4431 | } |
| 4432 | } |
| 4433 | } |
| 4434 | } |
| 4435 | }, |
| 4436 | "WorkspaceAppsResponse": { |
| 4437 | "type": "object", |
| 4438 | "required": [ |
| 4439 | "data" |
| 4440 | ], |
| 4441 | "properties": { |
| 4442 | "data": { |
| 4443 | "type": "object", |
| 4444 | "required": [ |
| 4445 | "installedApps", |
| 4446 | "catalog", |
| 4447 | "permissions" |
| 4448 | ], |
| 4449 | "properties": { |
| 4450 | "installedApps": { |
| 4451 | "type": "array", |
| 4452 | "items": { |
| 4453 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 4454 | } |
| 4455 | }, |
| 4456 | "catalog": { |
| 4457 | "type": "array", |
| 4458 | "items": { |
| 4459 | "$ref": "#/components/schemas/AppCatalogItem" |
| 4460 | } |
| 4461 | }, |
| 4462 | "permissions": { |
| 4463 | "type": "object", |
| 4464 | "required": [ |
| 4465 | "canManageApps" |
| 4466 | ], |
| 4467 | "properties": { |
| 4468 | "canManageApps": { |
| 4469 | "type": "boolean" |
| 4470 | } |
| 4471 | } |
| 4472 | } |
| 4473 | } |
| 4474 | } |
| 4475 | } |
| 4476 | }, |
| 4477 | "InstallWorkspaceAppInput": { |
| 4478 | "type": "object", |
| 4479 | "required": [ |
| 4480 | "appId" |
| 4481 | ], |
| 4482 | "properties": { |
| 4483 | "appId": { |
| 4484 | "type": "string" |
| 4485 | }, |
| 4486 | "pinnedVersionId": { |
| 4487 | "type": "string" |
| 4488 | }, |
| 4489 | "grantedPermissions": { |
| 4490 | "type": "array", |
| 4491 | "items": { |
| 4492 | "type": "string" |
| 4493 | } |
| 4494 | } |
| 4495 | } |
| 4496 | }, |
| 4497 | "InstallWorkspaceAppResponse": { |
| 4498 | "type": "object", |
| 4499 | "required": [ |
| 4500 | "data" |
| 4501 | ], |
| 4502 | "properties": { |
| 4503 | "data": { |
| 4504 | "type": "object", |
| 4505 | "required": [ |
| 4506 | "installId", |
| 4507 | "appId", |
| 4508 | "appKey", |
| 4509 | "version", |
| 4510 | "grantedPermissions" |
| 4511 | ], |
| 4512 | "properties": { |
| 4513 | "installId": { |
| 4514 | "type": "string" |
| 4515 | }, |
| 4516 | "appId": { |
| 4517 | "type": "string" |
| 4518 | }, |
| 4519 | "appKey": { |
| 4520 | "type": "string" |
| 4521 | }, |
| 4522 | "version": { |
| 4523 | "type": "string" |
| 4524 | }, |
| 4525 | "grantedPermissions": { |
| 4526 | "type": "array", |
| 4527 | "items": { |
| 4528 | "type": "string" |
| 4529 | } |
| 4530 | } |
| 4531 | } |
| 4532 | } |
| 4533 | } |
| 4534 | }, |
| 4535 | "WorkspaceInstalledAppResponse": { |
| 4536 | "type": "object", |
| 4537 | "required": [ |
| 4538 | "data" |
| 4539 | ], |
| 4540 | "properties": { |
| 4541 | "data": { |
| 4542 | "type": "object", |
| 4543 | "required": [ |
| 4544 | "install", |
| 4545 | "permissions" |
| 4546 | ], |
| 4547 | "properties": { |
| 4548 | "install": { |
| 4549 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 4550 | }, |
| 4551 | "permissions": { |
| 4552 | "type": "object", |
| 4553 | "required": [ |
| 4554 | "canManageApps" |
| 4555 | ], |
| 4556 | "properties": { |
| 4557 | "canManageApps": { |
| 4558 | "type": "boolean" |
| 4559 | } |
| 4560 | } |
| 4561 | } |
| 4562 | } |
| 4563 | } |
| 4564 | } |
| 4565 | }, |
| 4566 | "WorkspaceAppPermissionsResponse": { |
| 4567 | "type": "object", |
| 4568 | "required": [ |
| 4569 | "data" |
| 4570 | ], |
| 4571 | "properties": { |
| 4572 | "data": { |
| 4573 | "type": "object", |
| 4574 | "required": [ |
| 4575 | "install", |
| 4576 | "availablePermissions", |
| 4577 | "grantedPermissions", |
| 4578 | "permissions" |
| 4579 | ], |
| 4580 | "properties": { |
| 4581 | "install": { |
| 4582 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 4583 | }, |
| 4584 | "availablePermissions": { |
| 4585 | "type": "array", |
| 4586 | "items": { |
| 4587 | "type": "string" |
| 4588 | } |
| 4589 | }, |
| 4590 | "grantedPermissions": { |
| 4591 | "type": "array", |
| 4592 | "items": { |
| 4593 | "type": "string" |
| 4594 | } |
| 4595 | }, |
| 4596 | "permissions": { |
| 4597 | "type": "object", |
| 4598 | "required": [ |
| 4599 | "canManageApps" |
| 4600 | ], |
| 4601 | "properties": { |
| 4602 | "canManageApps": { |
| 4603 | "type": "boolean" |
| 4604 | } |
| 4605 | } |
| 4606 | } |
| 4607 | } |
| 4608 | } |
| 4609 | } |
| 4610 | }, |
| 4611 | "RegisterAppInput": { |
| 4612 | "type": "object", |
| 4613 | "required": [ |
| 4614 | "version", |
| 4615 | "manifest", |
| 4616 | "fileTypes" |
| 4617 | ], |
| 4618 | "properties": { |
| 4619 | "version": { |
| 4620 | "type": "string" |
| 4621 | }, |
| 4622 | "manifest": { |
| 4623 | "type": "object", |
| 4624 | "required": [ |
| 4625 | "key", |
| 4626 | "name", |
| 4627 | "permissions", |
| 4628 | "notificationChannels", |
| 4629 | "hosting" |
| 4630 | ], |
| 4631 | "properties": { |
| 4632 | "key": { |
| 4633 | "type": "string" |
| 4634 | }, |
| 4635 | "name": { |
| 4636 | "type": "string" |
| 4637 | }, |
| 4638 | "description": { |
| 4639 | "type": "string" |
| 4640 | }, |
| 4641 | "iconUrl": { |
| 4642 | "type": "string" |
| 4643 | }, |
| 4644 | "permissions": { |
| 4645 | "type": "array", |
| 4646 | "items": { |
| 4647 | "type": "string" |
| 4648 | } |
| 4649 | }, |
| 4650 | "notificationChannels": { |
| 4651 | "type": "array", |
| 4652 | "items": { |
| 4653 | "type": "object", |
| 4654 | "required": [ |
| 4655 | "key", |
| 4656 | "name", |
| 4657 | "defaultDeliveries", |
| 4658 | "defaultPriority" |
| 4659 | ], |
| 4660 | "properties": { |
| 4661 | "key": { |
| 4662 | "type": "string" |
| 4663 | }, |
| 4664 | "name": { |
| 4665 | "type": "string" |
| 4666 | }, |
| 4667 | "description": { |
| 4668 | "type": "string" |
| 4669 | }, |
| 4670 | "defaultDeliveries": { |
| 4671 | "type": "array", |
| 4672 | "items": { |
| 4673 | "type": "string" |
| 4674 | } |
| 4675 | }, |
| 4676 | "defaultPriority": { |
| 4677 | "type": "string" |
| 4678 | } |
| 4679 | } |
| 4680 | } |
| 4681 | }, |
| 4682 | "kairo": { |
| 4683 | "type": "object", |
| 4684 | "additionalProperties": true |
| 4685 | }, |
| 4686 | "hosting": { |
| 4687 | "type": "object", |
| 4688 | "required": [ |
| 4689 | "mode", |
| 4690 | "baseUrl" |
| 4691 | ], |
| 4692 | "properties": { |
| 4693 | "mode": { |
| 4694 | "type": "string", |
| 4695 | "const": "external" |
| 4696 | }, |
| 4697 | "baseUrl": { |
| 4698 | "type": "string" |
| 4699 | } |
| 4700 | } |
| 4701 | } |
| 4702 | } |
| 4703 | }, |
| 4704 | "fileTypes": { |
| 4705 | "type": "array", |
| 4706 | "items": { |
| 4707 | "type": "object", |
| 4708 | "required": [ |
| 4709 | "typeKey", |
| 4710 | "name", |
| 4711 | "storage", |
| 4712 | "indexable", |
| 4713 | "homeRenderMode" |
| 4714 | ], |
| 4715 | "properties": { |
| 4716 | "typeKey": { |
| 4717 | "type": "string" |
| 4718 | }, |
| 4719 | "name": { |
| 4720 | "type": "string" |
| 4721 | }, |
| 4722 | "description": { |
| 4723 | "type": "string" |
| 4724 | }, |
| 4725 | "storage": { |
| 4726 | "type": "string", |
| 4727 | "const": "coline_document" |
| 4728 | }, |
| 4729 | "indexable": { |
| 4730 | "type": "boolean" |
| 4731 | }, |
| 4732 | "homeRenderMode": { |
| 4733 | "type": "string" |
| 4734 | } |
| 4735 | } |
| 4736 | } |
| 4737 | } |
| 4738 | } |
| 4739 | }, |
| 4740 | "AppVersionMutationResponse": { |
| 4741 | "type": "object", |
| 4742 | "required": [ |
| 4743 | "data" |
| 4744 | ], |
| 4745 | "properties": { |
| 4746 | "data": { |
| 4747 | "type": "object", |
| 4748 | "required": [ |
| 4749 | "appId", |
| 4750 | "appKey", |
| 4751 | "versionId", |
| 4752 | "version" |
| 4753 | ], |
| 4754 | "properties": { |
| 4755 | "appId": { |
| 4756 | "type": "string" |
| 4757 | }, |
| 4758 | "appKey": { |
| 4759 | "type": "string" |
| 4760 | }, |
| 4761 | "versionId": { |
| 4762 | "type": "string" |
| 4763 | }, |
| 4764 | "version": { |
| 4765 | "type": "string" |
| 4766 | } |
| 4767 | } |
| 4768 | } |
| 4769 | } |
| 4770 | }, |
| 4771 | "SubmitAppVersionForReviewResponse": { |
| 4772 | "type": "object", |
| 4773 | "required": [ |
| 4774 | "data" |
| 4775 | ], |
| 4776 | "properties": { |
| 4777 | "data": { |
| 4778 | "type": "object", |
| 4779 | "required": [ |
| 4780 | "appId", |
| 4781 | "appKey", |
| 4782 | "versionId", |
| 4783 | "version", |
| 4784 | "reviewStatus", |
| 4785 | "storeListed" |
| 4786 | ], |
| 4787 | "properties": { |
| 4788 | "appId": { |
| 4789 | "type": "string" |
| 4790 | }, |
| 4791 | "appKey": { |
| 4792 | "type": "string" |
| 4793 | }, |
| 4794 | "versionId": { |
| 4795 | "type": "string" |
| 4796 | }, |
| 4797 | "version": { |
| 4798 | "type": "string" |
| 4799 | }, |
| 4800 | "reviewStatus": { |
| 4801 | "type": "string", |
| 4802 | "const": "submitted" |
| 4803 | }, |
| 4804 | "storeListed": { |
| 4805 | "type": "boolean" |
| 4806 | } |
| 4807 | } |
| 4808 | } |
| 4809 | } |
| 4810 | }, |
| 4811 | "WorkspaceAppSecretsResponse": { |
| 4812 | "type": "object", |
| 4813 | "required": [ |
| 4814 | "data" |
| 4815 | ], |
| 4816 | "properties": { |
| 4817 | "data": { |
| 4818 | "type": "object", |
| 4819 | "required": [ |
| 4820 | "install", |
| 4821 | "secrets", |
| 4822 | "permissions" |
| 4823 | ], |
| 4824 | "properties": { |
| 4825 | "install": { |
| 4826 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 4827 | }, |
| 4828 | "secrets": { |
| 4829 | "type": "array", |
| 4830 | "items": { |
| 4831 | "type": "object", |
| 4832 | "required": [ |
| 4833 | "id", |
| 4834 | "key", |
| 4835 | "createdAt", |
| 4836 | "updatedAt" |
| 4837 | ], |
| 4838 | "properties": { |
| 4839 | "id": { |
| 4840 | "type": "string" |
| 4841 | }, |
| 4842 | "key": { |
| 4843 | "type": "string" |
| 4844 | }, |
| 4845 | "createdAt": { |
| 4846 | "type": "string", |
| 4847 | "format": "date-time" |
| 4848 | }, |
| 4849 | "updatedAt": { |
| 4850 | "type": "string", |
| 4851 | "format": "date-time" |
| 4852 | } |
| 4853 | } |
| 4854 | } |
| 4855 | }, |
| 4856 | "permissions": { |
| 4857 | "type": "object", |
| 4858 | "required": [ |
| 4859 | "canManageApps" |
| 4860 | ], |
| 4861 | "properties": { |
| 4862 | "canManageApps": { |
| 4863 | "type": "boolean" |
| 4864 | } |
| 4865 | } |
| 4866 | } |
| 4867 | } |
| 4868 | } |
| 4869 | } |
| 4870 | }, |
| 4871 | "CreateWorkspaceAppSecretResponse": { |
| 4872 | "type": "object", |
| 4873 | "required": [ |
| 4874 | "data" |
| 4875 | ], |
| 4876 | "properties": { |
| 4877 | "data": { |
| 4878 | "type": "object", |
| 4879 | "required": [ |
| 4880 | "secret", |
| 4881 | "value" |
| 4882 | ], |
| 4883 | "properties": { |
| 4884 | "secret": { |
| 4885 | "type": "object", |
| 4886 | "required": [ |
| 4887 | "id", |
| 4888 | "key", |
| 4889 | "createdAt", |
| 4890 | "updatedAt" |
| 4891 | ], |
| 4892 | "properties": { |
| 4893 | "id": { |
| 4894 | "type": "string" |
| 4895 | }, |
| 4896 | "key": { |
| 4897 | "type": "string" |
| 4898 | }, |
| 4899 | "createdAt": { |
| 4900 | "type": "string", |
| 4901 | "format": "date-time" |
| 4902 | }, |
| 4903 | "updatedAt": { |
| 4904 | "type": "string", |
| 4905 | "format": "date-time" |
| 4906 | } |
| 4907 | } |
| 4908 | }, |
| 4909 | "value": { |
| 4910 | "type": "string" |
| 4911 | } |
| 4912 | } |
| 4913 | } |
| 4914 | } |
| 4915 | }, |
| 4916 | "WorkspaceAppOauthConnectionsResponse": { |
| 4917 | "type": "object", |
| 4918 | "required": [ |
| 4919 | "data" |
| 4920 | ], |
| 4921 | "properties": { |
| 4922 | "data": { |
| 4923 | "type": "object", |
| 4924 | "required": [ |
| 4925 | "install", |
| 4926 | "connections", |
| 4927 | "permissions" |
| 4928 | ], |
| 4929 | "properties": { |
| 4930 | "install": { |
| 4931 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 4932 | }, |
| 4933 | "connections": { |
| 4934 | "type": "array", |
| 4935 | "items": { |
| 4936 | "type": "object", |
| 4937 | "required": [ |
| 4938 | "id", |
| 4939 | "providerKey", |
| 4940 | "externalAccountId", |
| 4941 | "scopes", |
| 4942 | "tokenExpiresAt", |
| 4943 | "createdAt", |
| 4944 | "updatedAt" |
| 4945 | ], |
| 4946 | "properties": { |
| 4947 | "id": { |
| 4948 | "type": "string" |
| 4949 | }, |
| 4950 | "providerKey": { |
| 4951 | "type": "string" |
| 4952 | }, |
| 4953 | "externalAccountId": { |
| 4954 | "type": [ |
| 4955 | "string", |
| 4956 | "null" |
| 4957 | ] |
| 4958 | }, |
| 4959 | "scopes": { |
| 4960 | "type": "array", |
| 4961 | "items": { |
| 4962 | "type": "string" |
| 4963 | } |
| 4964 | }, |
| 4965 | "tokenExpiresAt": { |
| 4966 | "type": [ |
| 4967 | "string", |
| 4968 | "null" |
| 4969 | ], |
| 4970 | "format": "date-time" |
| 4971 | }, |
| 4972 | "createdAt": { |
| 4973 | "type": "string", |
| 4974 | "format": "date-time" |
| 4975 | }, |
| 4976 | "updatedAt": { |
| 4977 | "type": "string", |
| 4978 | "format": "date-time" |
| 4979 | } |
| 4980 | } |
| 4981 | } |
| 4982 | }, |
| 4983 | "permissions": { |
| 4984 | "type": "object", |
| 4985 | "required": [ |
| 4986 | "canManageApps" |
| 4987 | ], |
| 4988 | "properties": { |
| 4989 | "canManageApps": { |
| 4990 | "type": "boolean" |
| 4991 | } |
| 4992 | } |
| 4993 | } |
| 4994 | } |
| 4995 | } |
| 4996 | } |
| 4997 | }, |
| 4998 | "CreateWorkspaceAppOauthConnectionResponse": { |
| 4999 | "type": "object", |
| 5000 | "required": [ |
| 5001 | "data" |
| 5002 | ], |
| 5003 | "properties": { |
| 5004 | "data": { |
| 5005 | "type": "object", |
| 5006 | "required": [ |
| 5007 | "connection" |
| 5008 | ], |
| 5009 | "properties": { |
| 5010 | "connection": { |
| 5011 | "type": "object", |
| 5012 | "required": [ |
| 5013 | "id", |
| 5014 | "providerKey", |
| 5015 | "externalAccountId", |
| 5016 | "scopes", |
| 5017 | "tokenExpiresAt", |
| 5018 | "createdAt", |
| 5019 | "updatedAt" |
| 5020 | ], |
| 5021 | "properties": { |
| 5022 | "id": { |
| 5023 | "type": "string" |
| 5024 | }, |
| 5025 | "providerKey": { |
| 5026 | "type": "string" |
| 5027 | }, |
| 5028 | "externalAccountId": { |
| 5029 | "type": [ |
| 5030 | "string", |
| 5031 | "null" |
| 5032 | ] |
| 5033 | }, |
| 5034 | "scopes": { |
| 5035 | "type": "array", |
| 5036 | "items": { |
| 5037 | "type": "string" |
| 5038 | } |
| 5039 | }, |
| 5040 | "tokenExpiresAt": { |
| 5041 | "type": [ |
| 5042 | "string", |
| 5043 | "null" |
| 5044 | ], |
| 5045 | "format": "date-time" |
| 5046 | }, |
| 5047 | "createdAt": { |
| 5048 | "type": "string", |
| 5049 | "format": "date-time" |
| 5050 | }, |
| 5051 | "updatedAt": { |
| 5052 | "type": "string", |
| 5053 | "format": "date-time" |
| 5054 | } |
| 5055 | } |
| 5056 | } |
| 5057 | } |
| 5058 | } |
| 5059 | } |
| 5060 | }, |
| 5061 | "WorkspaceAppDeliveriesResponse": { |
| 5062 | "type": "object", |
| 5063 | "required": [ |
| 5064 | "data" |
| 5065 | ], |
| 5066 | "properties": { |
| 5067 | "data": { |
| 5068 | "type": "object", |
| 5069 | "required": [ |
| 5070 | "install", |
| 5071 | "deliveries", |
| 5072 | "permissions" |
| 5073 | ], |
| 5074 | "properties": { |
| 5075 | "install": { |
| 5076 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 5077 | }, |
| 5078 | "deliveries": { |
| 5079 | "type": "array", |
| 5080 | "items": { |
| 5081 | "type": "object", |
| 5082 | "required": [ |
| 5083 | "id", |
| 5084 | "eventType", |
| 5085 | "targetUrl", |
| 5086 | "status", |
| 5087 | "attemptCount", |
| 5088 | "lastStatusCode", |
| 5089 | "createdAt", |
| 5090 | "updatedAt" |
| 5091 | ], |
| 5092 | "properties": { |
| 5093 | "id": { |
| 5094 | "type": "string" |
| 5095 | }, |
| 5096 | "eventType": { |
| 5097 | "type": "string" |
| 5098 | }, |
| 5099 | "targetUrl": { |
| 5100 | "type": "string" |
| 5101 | }, |
| 5102 | "status": { |
| 5103 | "type": "string" |
| 5104 | }, |
| 5105 | "attemptCount": { |
| 5106 | "type": "integer" |
| 5107 | }, |
| 5108 | "lastStatusCode": { |
| 5109 | "type": [ |
| 5110 | "integer", |
| 5111 | "null" |
| 5112 | ] |
| 5113 | }, |
| 5114 | "createdAt": { |
| 5115 | "type": "string", |
| 5116 | "format": "date-time" |
| 5117 | }, |
| 5118 | "updatedAt": { |
| 5119 | "type": "string", |
| 5120 | "format": "date-time" |
| 5121 | } |
| 5122 | } |
| 5123 | } |
| 5124 | }, |
| 5125 | "permissions": { |
| 5126 | "type": "object", |
| 5127 | "required": [ |
| 5128 | "canManageApps" |
| 5129 | ], |
| 5130 | "properties": { |
| 5131 | "canManageApps": { |
| 5132 | "type": "boolean" |
| 5133 | } |
| 5134 | } |
| 5135 | } |
| 5136 | } |
| 5137 | } |
| 5138 | } |
| 5139 | }, |
| 5140 | "SendWorkspaceAppTestDeliveryResponse": { |
| 5141 | "type": "object", |
| 5142 | "required": [ |
| 5143 | "data" |
| 5144 | ], |
| 5145 | "properties": { |
| 5146 | "data": { |
| 5147 | "type": "object", |
| 5148 | "required": [ |
| 5149 | "delivery" |
| 5150 | ], |
| 5151 | "properties": { |
| 5152 | "delivery": { |
| 5153 | "type": "object", |
| 5154 | "required": [ |
| 5155 | "id", |
| 5156 | "eventType", |
| 5157 | "targetUrl", |
| 5158 | "status", |
| 5159 | "attemptCount", |
| 5160 | "lastStatusCode", |
| 5161 | "createdAt", |
| 5162 | "updatedAt" |
| 5163 | ], |
| 5164 | "properties": { |
| 5165 | "id": { |
| 5166 | "type": "string" |
| 5167 | }, |
| 5168 | "eventType": { |
| 5169 | "type": "string" |
| 5170 | }, |
| 5171 | "targetUrl": { |
| 5172 | "type": "string" |
| 5173 | }, |
| 5174 | "status": { |
| 5175 | "type": "string" |
| 5176 | }, |
| 5177 | "attemptCount": { |
| 5178 | "type": "integer" |
| 5179 | }, |
| 5180 | "lastStatusCode": { |
| 5181 | "type": [ |
| 5182 | "integer", |
| 5183 | "null" |
| 5184 | ] |
| 5185 | }, |
| 5186 | "createdAt": { |
| 5187 | "type": "string", |
| 5188 | "format": "date-time" |
| 5189 | }, |
| 5190 | "updatedAt": { |
| 5191 | "type": "string", |
| 5192 | "format": "date-time" |
| 5193 | } |
| 5194 | } |
| 5195 | } |
| 5196 | } |
| 5197 | } |
| 5198 | } |
| 5199 | }, |
| 5200 | "AppFilesListResponse": { |
| 5201 | "type": "object", |
| 5202 | "required": [ |
| 5203 | "data" |
| 5204 | ], |
| 5205 | "properties": { |
| 5206 | "data": { |
| 5207 | "type": "object", |
| 5208 | "required": [ |
| 5209 | "files", |
| 5210 | "availableFileTypes" |
| 5211 | ], |
| 5212 | "properties": { |
| 5213 | "files": { |
| 5214 | "type": "array", |
| 5215 | "items": { |
| 5216 | "type": "object", |
| 5217 | "required": [ |
| 5218 | "id", |
| 5219 | "driveId", |
| 5220 | "parentId", |
| 5221 | "name", |
| 5222 | "fileType", |
| 5223 | "typeLabel", |
| 5224 | "appKey", |
| 5225 | "appName", |
| 5226 | "openHref", |
| 5227 | "updatedAt", |
| 5228 | "createdAt", |
| 5229 | "version", |
| 5230 | "capabilities" |
| 5231 | ], |
| 5232 | "properties": { |
| 5233 | "id": { |
| 5234 | "type": "string" |
| 5235 | }, |
| 5236 | "driveId": { |
| 5237 | "type": "string" |
| 5238 | }, |
| 5239 | "parentId": { |
| 5240 | "type": [ |
| 5241 | "string", |
| 5242 | "null" |
| 5243 | ] |
| 5244 | }, |
| 5245 | "name": { |
| 5246 | "type": "string" |
| 5247 | }, |
| 5248 | "fileType": { |
| 5249 | "type": "string" |
| 5250 | }, |
| 5251 | "typeLabel": { |
| 5252 | "type": "string" |
| 5253 | }, |
| 5254 | "appKey": { |
| 5255 | "type": "string" |
| 5256 | }, |
| 5257 | "appName": { |
| 5258 | "type": "string" |
| 5259 | }, |
| 5260 | "openHref": { |
| 5261 | "type": "string" |
| 5262 | }, |
| 5263 | "updatedAt": { |
| 5264 | "type": "string", |
| 5265 | "format": "date-time" |
| 5266 | }, |
| 5267 | "createdAt": { |
| 5268 | "type": "string", |
| 5269 | "format": "date-time" |
| 5270 | }, |
| 5271 | "version": { |
| 5272 | "type": "integer" |
| 5273 | }, |
| 5274 | "capabilities": { |
| 5275 | "type": "object", |
| 5276 | "required": [ |
| 5277 | "canRead", |
| 5278 | "canWrite", |
| 5279 | "canManage" |
| 5280 | ], |
| 5281 | "properties": { |
| 5282 | "canRead": { |
| 5283 | "type": "boolean" |
| 5284 | }, |
| 5285 | "canWrite": { |
| 5286 | "type": "boolean" |
| 5287 | }, |
| 5288 | "canManage": { |
| 5289 | "type": "boolean" |
| 5290 | } |
| 5291 | } |
| 5292 | } |
| 5293 | } |
| 5294 | } |
| 5295 | }, |
| 5296 | "availableFileTypes": { |
| 5297 | "type": "array", |
| 5298 | "items": { |
| 5299 | "type": "object", |
| 5300 | "required": [ |
| 5301 | "typeKey", |
| 5302 | "name", |
| 5303 | "description" |
| 5304 | ], |
| 5305 | "properties": { |
| 5306 | "typeKey": { |
| 5307 | "type": "string" |
| 5308 | }, |
| 5309 | "name": { |
| 5310 | "type": "string" |
| 5311 | }, |
| 5312 | "description": { |
| 5313 | "type": [ |
| 5314 | "string", |
| 5315 | "null" |
| 5316 | ] |
| 5317 | } |
| 5318 | } |
| 5319 | } |
| 5320 | } |
| 5321 | } |
| 5322 | } |
| 5323 | } |
| 5324 | }, |
| 5325 | "CreateAppFileInput": { |
| 5326 | "type": "object", |
| 5327 | "required": [ |
| 5328 | "name" |
| 5329 | ], |
| 5330 | "properties": { |
| 5331 | "name": { |
| 5332 | "type": "string" |
| 5333 | }, |
| 5334 | "typeKey": { |
| 5335 | "type": "string" |
| 5336 | }, |
| 5337 | "driveId": { |
| 5338 | "type": "string" |
| 5339 | }, |
| 5340 | "parentId": { |
| 5341 | "type": [ |
| 5342 | "string", |
| 5343 | "null" |
| 5344 | ] |
| 5345 | }, |
| 5346 | "document": { |
| 5347 | "type": "object", |
| 5348 | "additionalProperties": true |
| 5349 | } |
| 5350 | } |
| 5351 | }, |
| 5352 | "CreateAppFileResponse": { |
| 5353 | "type": "object", |
| 5354 | "required": [ |
| 5355 | "data" |
| 5356 | ], |
| 5357 | "properties": { |
| 5358 | "data": { |
| 5359 | "type": "object", |
| 5360 | "required": [ |
| 5361 | "file", |
| 5362 | "document", |
| 5363 | "version" |
| 5364 | ], |
| 5365 | "properties": { |
| 5366 | "file": { |
| 5367 | "type": "object", |
| 5368 | "required": [ |
| 5369 | "id", |
| 5370 | "driveId", |
| 5371 | "parentId", |
| 5372 | "name", |
| 5373 | "fileType", |
| 5374 | "typeLabel", |
| 5375 | "appKey", |
| 5376 | "appName", |
| 5377 | "openHref", |
| 5378 | "updatedAt", |
| 5379 | "createdAt", |
| 5380 | "version", |
| 5381 | "capabilities" |
| 5382 | ], |
| 5383 | "properties": { |
| 5384 | "id": { |
| 5385 | "type": "string" |
| 5386 | }, |
| 5387 | "driveId": { |
| 5388 | "type": "string" |
| 5389 | }, |
| 5390 | "parentId": { |
| 5391 | "type": [ |
| 5392 | "string", |
| 5393 | "null" |
| 5394 | ] |
| 5395 | }, |
| 5396 | "name": { |
| 5397 | "type": "string" |
| 5398 | }, |
| 5399 | "fileType": { |
| 5400 | "type": "string" |
| 5401 | }, |
| 5402 | "typeLabel": { |
| 5403 | "type": "string" |
| 5404 | }, |
| 5405 | "appKey": { |
| 5406 | "type": "string" |
| 5407 | }, |
| 5408 | "appName": { |
| 5409 | "type": "string" |
| 5410 | }, |
| 5411 | "openHref": { |
| 5412 | "type": "string" |
| 5413 | }, |
| 5414 | "updatedAt": { |
| 5415 | "type": "string", |
| 5416 | "format": "date-time" |
| 5417 | }, |
| 5418 | "createdAt": { |
| 5419 | "type": "string", |
| 5420 | "format": "date-time" |
| 5421 | }, |
| 5422 | "version": { |
| 5423 | "type": "integer" |
| 5424 | }, |
| 5425 | "capabilities": { |
| 5426 | "type": "object", |
| 5427 | "required": [ |
| 5428 | "canRead", |
| 5429 | "canWrite", |
| 5430 | "canManage" |
| 5431 | ], |
| 5432 | "properties": { |
| 5433 | "canRead": { |
| 5434 | "type": "boolean" |
| 5435 | }, |
| 5436 | "canWrite": { |
| 5437 | "type": "boolean" |
| 5438 | }, |
| 5439 | "canManage": { |
| 5440 | "type": "boolean" |
| 5441 | } |
| 5442 | } |
| 5443 | } |
| 5444 | } |
| 5445 | }, |
| 5446 | "document": { |
| 5447 | "type": "object", |
| 5448 | "additionalProperties": true |
| 5449 | }, |
| 5450 | "version": { |
| 5451 | "type": "integer" |
| 5452 | } |
| 5453 | } |
| 5454 | } |
| 5455 | } |
| 5456 | }, |
| 5457 | "ExecuteAppActionInput": { |
| 5458 | "type": "object", |
| 5459 | "required": [ |
| 5460 | "action" |
| 5461 | ], |
| 5462 | "properties": { |
| 5463 | "action": { |
| 5464 | "type": "object", |
| 5465 | "required": [ |
| 5466 | "type" |
| 5467 | ], |
| 5468 | "properties": { |
| 5469 | "type": { |
| 5470 | "type": "string" |
| 5471 | }, |
| 5472 | "payload": { |
| 5473 | "type": "object", |
| 5474 | "additionalProperties": true |
| 5475 | } |
| 5476 | } |
| 5477 | }, |
| 5478 | "fileId": { |
| 5479 | "type": [ |
| 5480 | "string", |
| 5481 | "null" |
| 5482 | ] |
| 5483 | } |
| 5484 | } |
| 5485 | }, |
| 5486 | "ExecuteAppActionResponse": { |
| 5487 | "type": "object", |
| 5488 | "required": [ |
| 5489 | "data" |
| 5490 | ], |
| 5491 | "properties": { |
| 5492 | "data": { |
| 5493 | "oneOf": [ |
| 5494 | { |
| 5495 | "type": "object", |
| 5496 | "required": [ |
| 5497 | "type" |
| 5498 | ], |
| 5499 | "properties": { |
| 5500 | "type": { |
| 5501 | "type": "string", |
| 5502 | "enum": [ |
| 5503 | "ok", |
| 5504 | "refresh" |
| 5505 | ] |
| 5506 | } |
| 5507 | } |
| 5508 | }, |
| 5509 | { |
| 5510 | "type": "object", |
| 5511 | "required": [ |
| 5512 | "type", |
| 5513 | "href" |
| 5514 | ], |
| 5515 | "properties": { |
| 5516 | "type": { |
| 5517 | "type": "string", |
| 5518 | "enum": [ |
| 5519 | "navigate" |
| 5520 | ] |
| 5521 | }, |
| 5522 | "href": { |
| 5523 | "type": "string" |
| 5524 | } |
| 5525 | } |
| 5526 | }, |
| 5527 | { |
| 5528 | "type": "object", |
| 5529 | "required": [ |
| 5530 | "type", |
| 5531 | "fileId" |
| 5532 | ], |
| 5533 | "properties": { |
| 5534 | "type": { |
| 5535 | "type": "string", |
| 5536 | "enum": [ |
| 5537 | "open_file" |
| 5538 | ] |
| 5539 | }, |
| 5540 | "fileId": { |
| 5541 | "type": "string" |
| 5542 | } |
| 5543 | } |
| 5544 | } |
| 5545 | ] |
| 5546 | } |
| 5547 | } |
| 5548 | }, |
| 5549 | "AppFileDocumentResponse": { |
| 5550 | "type": "object", |
| 5551 | "required": [ |
| 5552 | "data" |
| 5553 | ], |
| 5554 | "properties": { |
| 5555 | "data": { |
| 5556 | "type": "object", |
| 5557 | "required": [ |
| 5558 | "file", |
| 5559 | "document", |
| 5560 | "version", |
| 5561 | "capabilities" |
| 5562 | ], |
| 5563 | "properties": { |
| 5564 | "file": { |
| 5565 | "type": "object", |
| 5566 | "required": [ |
| 5567 | "id", |
| 5568 | "name", |
| 5569 | "fileType", |
| 5570 | "appKey", |
| 5571 | "appName", |
| 5572 | "typeLabel", |
| 5573 | "openHref", |
| 5574 | "updatedAt" |
| 5575 | ], |
| 5576 | "properties": { |
| 5577 | "id": { |
| 5578 | "type": "string" |
| 5579 | }, |
| 5580 | "name": { |
| 5581 | "type": "string" |
| 5582 | }, |
| 5583 | "fileType": { |
| 5584 | "type": "string" |
| 5585 | }, |
| 5586 | "appKey": { |
| 5587 | "type": "string" |
| 5588 | }, |
| 5589 | "appName": { |
| 5590 | "type": "string" |
| 5591 | }, |
| 5592 | "typeLabel": { |
| 5593 | "type": "string" |
| 5594 | }, |
| 5595 | "openHref": { |
| 5596 | "type": "string" |
| 5597 | }, |
| 5598 | "updatedAt": { |
| 5599 | "type": "string", |
| 5600 | "format": "date-time" |
| 5601 | } |
| 5602 | } |
| 5603 | }, |
| 5604 | "document": { |
| 5605 | "type": "object", |
| 5606 | "additionalProperties": true |
| 5607 | }, |
| 5608 | "version": { |
| 5609 | "type": "integer" |
| 5610 | }, |
| 5611 | "capabilities": { |
| 5612 | "type": "object", |
| 5613 | "required": [ |
| 5614 | "canRead", |
| 5615 | "canWrite", |
| 5616 | "canManage" |
| 5617 | ], |
| 5618 | "properties": { |
| 5619 | "canRead": { |
| 5620 | "type": "boolean" |
| 5621 | }, |
| 5622 | "canWrite": { |
| 5623 | "type": "boolean" |
| 5624 | }, |
| 5625 | "canManage": { |
| 5626 | "type": "boolean" |
| 5627 | } |
| 5628 | } |
| 5629 | } |
| 5630 | } |
| 5631 | } |
| 5632 | } |
| 5633 | }, |
| 5634 | "AppFileDocumentUpdateResponse": { |
| 5635 | "type": "object", |
| 5636 | "required": [ |
| 5637 | "data" |
| 5638 | ], |
| 5639 | "properties": { |
| 5640 | "data": { |
| 5641 | "type": "object", |
| 5642 | "required": [ |
| 5643 | "document", |
| 5644 | "version", |
| 5645 | "updatedAt" |
| 5646 | ], |
| 5647 | "properties": { |
| 5648 | "document": { |
| 5649 | "type": "object", |
| 5650 | "additionalProperties": true |
| 5651 | }, |
| 5652 | "version": { |
| 5653 | "type": "integer" |
| 5654 | }, |
| 5655 | "updatedAt": { |
| 5656 | "type": "string", |
| 5657 | "format": "date-time" |
| 5658 | } |
| 5659 | } |
| 5660 | } |
| 5661 | } |
| 5662 | }, |
| 5663 | "CreateAppNotificationInput": { |
| 5664 | "type": "object", |
| 5665 | "required": [ |
| 5666 | "channelKey", |
| 5667 | "typeKey", |
| 5668 | "recipients", |
| 5669 | "title" |
| 5670 | ], |
| 5671 | "properties": { |
| 5672 | "channelKey": { |
| 5673 | "type": "string" |
| 5674 | }, |
| 5675 | "typeKey": { |
| 5676 | "type": "string" |
| 5677 | }, |
| 5678 | "recipients": { |
| 5679 | "type": "array", |
| 5680 | "items": { |
| 5681 | "type": "object", |
| 5682 | "required": [ |
| 5683 | "userId" |
| 5684 | ], |
| 5685 | "properties": { |
| 5686 | "userId": { |
| 5687 | "type": "string" |
| 5688 | } |
| 5689 | } |
| 5690 | } |
| 5691 | }, |
| 5692 | "title": { |
| 5693 | "type": "string" |
| 5694 | }, |
| 5695 | "body": { |
| 5696 | "type": "string" |
| 5697 | }, |
| 5698 | "targetUrl": { |
| 5699 | "type": "string" |
| 5700 | }, |
| 5701 | "icon": { |
| 5702 | "type": "string" |
| 5703 | }, |
| 5704 | "priority": { |
| 5705 | "type": "string" |
| 5706 | }, |
| 5707 | "dedupeKey": { |
| 5708 | "type": "string" |
| 5709 | }, |
| 5710 | "metadata": { |
| 5711 | "type": "object", |
| 5712 | "additionalProperties": true |
| 5713 | } |
| 5714 | } |
| 5715 | }, |
| 5716 | "UpsertAppIndexDocumentsInput": { |
| 5717 | "type": "object", |
| 5718 | "required": [ |
| 5719 | "documents" |
| 5720 | ], |
| 5721 | "properties": { |
| 5722 | "documents": { |
| 5723 | "type": "array", |
| 5724 | "items": { |
| 5725 | "type": "object", |
| 5726 | "required": [ |
| 5727 | "documentKey", |
| 5728 | "documentType", |
| 5729 | "title" |
| 5730 | ], |
| 5731 | "properties": { |
| 5732 | "documentKey": { |
| 5733 | "type": "string" |
| 5734 | }, |
| 5735 | "documentType": { |
| 5736 | "type": "string" |
| 5737 | }, |
| 5738 | "fileId": { |
| 5739 | "type": "string" |
| 5740 | }, |
| 5741 | "title": { |
| 5742 | "type": "string" |
| 5743 | }, |
| 5744 | "body": { |
| 5745 | "type": "string" |
| 5746 | }, |
| 5747 | "url": { |
| 5748 | "type": "string" |
| 5749 | }, |
| 5750 | "metadata": { |
| 5751 | "type": "object", |
| 5752 | "additionalProperties": true |
| 5753 | }, |
| 5754 | "visibilityMode": { |
| 5755 | "type": "string" |
| 5756 | }, |
| 5757 | "visibility": { |
| 5758 | "type": "array", |
| 5759 | "items": { |
| 5760 | "type": "object", |
| 5761 | "required": [ |
| 5762 | "subjectType", |
| 5763 | "subjectId" |
| 5764 | ], |
| 5765 | "properties": { |
| 5766 | "subjectType": { |
| 5767 | "type": "string" |
| 5768 | }, |
| 5769 | "subjectId": { |
| 5770 | "type": "string" |
| 5771 | } |
| 5772 | } |
| 5773 | } |
| 5774 | } |
| 5775 | } |
| 5776 | } |
| 5777 | } |
| 5778 | } |
| 5779 | }, |
| 5780 | "UpsertAppIndexDocumentsResponse": { |
| 5781 | "type": "object", |
| 5782 | "required": [ |
| 5783 | "data" |
| 5784 | ], |
| 5785 | "properties": { |
| 5786 | "data": { |
| 5787 | "type": "object", |
| 5788 | "required": [ |
| 5789 | "documents" |
| 5790 | ], |
| 5791 | "properties": { |
| 5792 | "documents": { |
| 5793 | "type": "array", |
| 5794 | "items": { |
| 5795 | "type": "object", |
| 5796 | "required": [ |
| 5797 | "id", |
| 5798 | "documentKey", |
| 5799 | "visibilityMode" |
| 5800 | ], |
| 5801 | "properties": { |
| 5802 | "id": { |
| 5803 | "type": "string" |
| 5804 | }, |
| 5805 | "documentKey": { |
| 5806 | "type": "string" |
| 5807 | }, |
| 5808 | "visibilityMode": { |
| 5809 | "type": "string" |
| 5810 | } |
| 5811 | } |
| 5812 | } |
| 5813 | } |
| 5814 | } |
| 5815 | } |
| 5816 | } |
| 5817 | }, |
| 5818 | "DeleteAppIndexDocumentsInput": { |
| 5819 | "type": "object", |
| 5820 | "required": [ |
| 5821 | "documentKeys" |
| 5822 | ], |
| 5823 | "properties": { |
| 5824 | "documentKeys": { |
| 5825 | "type": "array", |
| 5826 | "items": { |
| 5827 | "type": "string" |
| 5828 | } |
| 5829 | } |
| 5830 | } |
| 5831 | }, |
| 5832 | "DeleteAppIndexDocumentsResponse": { |
| 5833 | "type": "object", |
| 5834 | "required": [ |
| 5835 | "data" |
| 5836 | ], |
| 5837 | "properties": { |
| 5838 | "data": { |
| 5839 | "type": "object", |
| 5840 | "required": [ |
| 5841 | "deleted" |
| 5842 | ], |
| 5843 | "properties": { |
| 5844 | "deleted": { |
| 5845 | "type": "array", |
| 5846 | "items": { |
| 5847 | "type": "object", |
| 5848 | "required": [ |
| 5849 | "id", |
| 5850 | "documentKey" |
| 5851 | ], |
| 5852 | "properties": { |
| 5853 | "id": { |
| 5854 | "type": "string" |
| 5855 | }, |
| 5856 | "documentKey": { |
| 5857 | "type": "string" |
| 5858 | } |
| 5859 | } |
| 5860 | } |
| 5861 | } |
| 5862 | } |
| 5863 | } |
| 5864 | } |
| 5865 | }, |
| 5866 | "EmitAppAmbientEventsInput": { |
| 5867 | "type": "object", |
| 5868 | "required": [ |
| 5869 | "events" |
| 5870 | ], |
| 5871 | "properties": { |
| 5872 | "events": { |
| 5873 | "type": "array", |
| 5874 | "items": { |
| 5875 | "type": "object", |
| 5876 | "required": [ |
| 5877 | "sourceKind", |
| 5878 | "action", |
| 5879 | "entityType", |
| 5880 | "entityId", |
| 5881 | "dedupeKey" |
| 5882 | ], |
| 5883 | "properties": { |
| 5884 | "sourceKind": { |
| 5885 | "type": "string" |
| 5886 | }, |
| 5887 | "action": { |
| 5888 | "type": "string" |
| 5889 | }, |
| 5890 | "entityType": { |
| 5891 | "type": "string" |
| 5892 | }, |
| 5893 | "entityId": { |
| 5894 | "type": "string" |
| 5895 | }, |
| 5896 | "actorUserId": { |
| 5897 | "type": "string" |
| 5898 | }, |
| 5899 | "containerType": { |
| 5900 | "type": "string" |
| 5901 | }, |
| 5902 | "containerId": { |
| 5903 | "type": "string" |
| 5904 | }, |
| 5905 | "occurredAt": { |
| 5906 | "type": "string", |
| 5907 | "format": "date-time" |
| 5908 | }, |
| 5909 | "dedupeKey": { |
| 5910 | "type": "string" |
| 5911 | }, |
| 5912 | "payload": { |
| 5913 | "type": "object", |
| 5914 | "additionalProperties": true |
| 5915 | }, |
| 5916 | "metadata": { |
| 5917 | "type": "object", |
| 5918 | "additionalProperties": true |
| 5919 | }, |
| 5920 | "schemaVersion": { |
| 5921 | "type": "integer" |
| 5922 | } |
| 5923 | } |
| 5924 | } |
| 5925 | } |
| 5926 | } |
| 5927 | }, |
| 5928 | "EmitAppAmbientEventsResponse": { |
| 5929 | "type": "object", |
| 5930 | "required": [ |
| 5931 | "data" |
| 5932 | ], |
| 5933 | "properties": { |
| 5934 | "data": { |
| 5935 | "type": "object", |
| 5936 | "required": [ |
| 5937 | "events" |
| 5938 | ], |
| 5939 | "properties": { |
| 5940 | "events": { |
| 5941 | "type": "array", |
| 5942 | "items": { |
| 5943 | "type": "object", |
| 5944 | "required": [ |
| 5945 | "id", |
| 5946 | "dedupeKey" |
| 5947 | ], |
| 5948 | "properties": { |
| 5949 | "id": { |
| 5950 | "type": "string" |
| 5951 | }, |
| 5952 | "dedupeKey": { |
| 5953 | "type": "string" |
| 5954 | } |
| 5955 | } |
| 5956 | } |
| 5957 | } |
| 5958 | } |
| 5959 | } |
| 5960 | } |
| 5961 | }, |
| 5962 | "WorkspaceMember": { |
| 5963 | "type": "object", |
| 5964 | "required": ["id", "workspaceMemberId", "email", "joinedAt", "roles"], |
| 5965 | "properties": { |
| 5966 | "id": { "type": "string", "description": "User ID" }, |
| 5967 | "workspaceMemberId": { "type": "string" }, |
| 5968 | "email": { "type": "string", "format": "email" }, |
| 5969 | "firstName": { "type": "string", "nullable": true }, |
| 5970 | "lastName": { "type": "string", "nullable": true }, |
| 5971 | "avatarUrl": { "type": "string", "nullable": true }, |
| 5972 | "joinedAt": { "type": "string", "format": "date-time" }, |
| 5973 | "roles": { "type": "array", "items": { "type": "string" } } |
| 5974 | } |
| 5975 | }, |
| 5976 | "ListWorkspaceMembersResponse": { |
| 5977 | "type": "object", |
| 5978 | "required": ["data"], |
| 5979 | "properties": { |
| 5980 | "data": { |
| 5981 | "type": "object", |
| 5982 | "required": ["members"], |
| 5983 | "properties": { |
| 5984 | "members": { |
| 5985 | "type": "array", |
| 5986 | "items": { "$ref": "#/components/schemas/WorkspaceMember" } |
| 5987 | } |
| 5988 | } |
| 5989 | } |
| 5990 | } |
| 5991 | }, |
| 5992 | "NoteSummary": { |
| 5993 | "type": "object", |
| 5994 | "required": ["id", "driveId", "title", "body", "createdAt", "updatedAt"], |
| 5995 | "properties": { |
| 5996 | "id": { "type": "string" }, |
| 5997 | "driveId": { "type": "string" }, |
| 5998 | "parentId": { "type": "string", "nullable": true }, |
| 5999 | "title": { "type": "string" }, |
| 6000 | "body": { "type": "string", "description": "Plaintext body content" }, |
| 6001 | "color": { "type": "string", "nullable": true }, |
| 6002 | "createdByUserId": { "type": "string", "nullable": true }, |
| 6003 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6004 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6005 | } |
| 6006 | }, |
| 6007 | "PaginationInfo": { |
| 6008 | "type": "object", |
| 6009 | "required": ["limit", "hasMore"], |
| 6010 | "properties": { |
| 6011 | "limit": { "type": "integer" }, |
| 6012 | "hasMore": { "type": "boolean" }, |
| 6013 | "nextCursor": { "type": "string", "nullable": true } |
| 6014 | } |
| 6015 | }, |
| 6016 | "ListWorkspaceNotesResponse": { |
| 6017 | "type": "object", |
| 6018 | "required": ["data"], |
| 6019 | "properties": { |
| 6020 | "data": { |
| 6021 | "type": "object", |
| 6022 | "required": ["notes", "page"], |
| 6023 | "properties": { |
| 6024 | "notes": { |
| 6025 | "type": "array", |
| 6026 | "items": { "$ref": "#/components/schemas/NoteSummary" } |
| 6027 | }, |
| 6028 | "page": { "$ref": "#/components/schemas/PaginationInfo" } |
| 6029 | } |
| 6030 | } |
| 6031 | } |
| 6032 | }, |
| 6033 | "CreateNoteInput": { |
| 6034 | "type": "object", |
| 6035 | "properties": { |
| 6036 | "title": { "type": "string", "maxLength": 120 }, |
| 6037 | "body": { "type": "string", "maxLength": 250000, "default": "" }, |
| 6038 | "blocks": { |
| 6039 | "type": "array", |
| 6040 | "items": { "type": "object" }, |
| 6041 | "description": "BlockNote block array" |
| 6042 | }, |
| 6043 | "driveId": { "type": "string", "description": "Target drive ID (defaults to workspace default drive)" }, |
| 6044 | "parentId": { "type": "string", "nullable": true, "description": "Parent folder ID" } |
| 6045 | } |
| 6046 | }, |
| 6047 | "NoteResponse": { |
| 6048 | "type": "object", |
| 6049 | "required": ["data"], |
| 6050 | "properties": { |
| 6051 | "data": { |
| 6052 | "type": "object", |
| 6053 | "required": ["note"], |
| 6054 | "properties": { |
| 6055 | "note": { "$ref": "#/components/schemas/NoteSummary" } |
| 6056 | } |
| 6057 | } |
| 6058 | } |
| 6059 | }, |
| 6060 | "NoteDetail": { |
| 6061 | "type": "object", |
| 6062 | "required": ["id", "driveId", "title", "body", "blocks", "createdAt", "updatedAt"], |
| 6063 | "properties": { |
| 6064 | "id": { "type": "string" }, |
| 6065 | "driveId": { "type": "string" }, |
| 6066 | "parentId": { "type": "string", "nullable": true }, |
| 6067 | "title": { "type": "string" }, |
| 6068 | "body": { "type": "string" }, |
| 6069 | "blocks": { "type": "array", "items": { "type": "object" } }, |
| 6070 | "color": { "type": "string", "nullable": true }, |
| 6071 | "createdByUserId": { "type": "string", "nullable": true }, |
| 6072 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6073 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6074 | } |
| 6075 | }, |
| 6076 | "NoteDetailResponse": { |
| 6077 | "type": "object", |
| 6078 | "required": ["data"], |
| 6079 | "properties": { |
| 6080 | "data": { |
| 6081 | "type": "object", |
| 6082 | "required": ["note"], |
| 6083 | "properties": { |
| 6084 | "note": { "$ref": "#/components/schemas/NoteDetail" } |
| 6085 | } |
| 6086 | } |
| 6087 | } |
| 6088 | }, |
| 6089 | "UpdateNoteInput": { |
| 6090 | "type": "object", |
| 6091 | "properties": { |
| 6092 | "title": { "type": "string", "maxLength": 120 }, |
| 6093 | "body": { "type": "string", "maxLength": 250000 }, |
| 6094 | "blocks": { |
| 6095 | "type": "array", |
| 6096 | "items": { "type": "object" }, |
| 6097 | "description": "BlockNote block array" |
| 6098 | } |
| 6099 | } |
| 6100 | }, |
| 6101 | "DocLayout": { |
| 6102 | "type": "object", |
| 6103 | "required": ["mode", "pageSize", "orientation", "margins", "showPageNumbers"], |
| 6104 | "properties": { |
| 6105 | "mode": { "type": "string", "const": "pages" }, |
| 6106 | "pageSize": { "type": "string", "const": "letter" }, |
| 6107 | "orientation": { "type": "string", "enum": ["portrait", "landscape"] }, |
| 6108 | "margins": { "type": "string", "enum": ["normal", "narrow", "wide"] }, |
| 6109 | "backgroundColor": { "type": "string", "nullable": true }, |
| 6110 | "showPageNumbers": { "type": "boolean" } |
| 6111 | } |
| 6112 | }, |
| 6113 | "DocSummary": { |
| 6114 | "type": "object", |
| 6115 | "required": ["id", "driveId", "title", "excerpt", "layout", "createdAt", "updatedAt"], |
| 6116 | "properties": { |
| 6117 | "id": { "type": "string" }, |
| 6118 | "driveId": { "type": "string" }, |
| 6119 | "parentId": { "type": "string", "nullable": true }, |
| 6120 | "title": { "type": "string" }, |
| 6121 | "excerpt": { "type": "string", "description": "First ~160 chars of doc plaintext" }, |
| 6122 | "color": { "type": "string", "nullable": true }, |
| 6123 | "layout": { "$ref": "#/components/schemas/DocLayout" }, |
| 6124 | "createdByUserId": { "type": "string", "nullable": true }, |
| 6125 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6126 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6127 | } |
| 6128 | }, |
| 6129 | "DocDetail": { |
| 6130 | "type": "object", |
| 6131 | "required": ["id", "driveId", "title", "content", "plainText", "layout", "createdAt", "updatedAt"], |
| 6132 | "properties": { |
| 6133 | "id": { "type": "string" }, |
| 6134 | "driveId": { "type": "string" }, |
| 6135 | "parentId": { "type": "string", "nullable": true }, |
| 6136 | "title": { "type": "string" }, |
| 6137 | "content": { "type": "object", "description": "PagedDocContent structure with type='doc' and pages array" }, |
| 6138 | "plainText": { "type": "string" }, |
| 6139 | "color": { "type": "string", "nullable": true }, |
| 6140 | "layout": { "$ref": "#/components/schemas/DocLayout" }, |
| 6141 | "createdByUserId": { "type": "string", "nullable": true }, |
| 6142 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6143 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6144 | } |
| 6145 | }, |
| 6146 | "ListWorkspaceDocsResponse": { |
| 6147 | "type": "object", |
| 6148 | "required": ["data"], |
| 6149 | "properties": { |
| 6150 | "data": { |
| 6151 | "type": "object", |
| 6152 | "required": ["docs", "page"], |
| 6153 | "properties": { |
| 6154 | "docs": { |
| 6155 | "type": "array", |
| 6156 | "items": { "$ref": "#/components/schemas/DocSummary" } |
| 6157 | }, |
| 6158 | "page": { "$ref": "#/components/schemas/PaginationInfo" } |
| 6159 | } |
| 6160 | } |
| 6161 | } |
| 6162 | }, |
| 6163 | "DocResponse": { |
| 6164 | "type": "object", |
| 6165 | "required": ["data"], |
| 6166 | "properties": { |
| 6167 | "data": { |
| 6168 | "type": "object", |
| 6169 | "required": ["doc"], |
| 6170 | "properties": { |
| 6171 | "doc": { "$ref": "#/components/schemas/DocSummary" } |
| 6172 | } |
| 6173 | } |
| 6174 | } |
| 6175 | }, |
| 6176 | "DocDetailResponse": { |
| 6177 | "type": "object", |
| 6178 | "required": ["data"], |
| 6179 | "properties": { |
| 6180 | "data": { |
| 6181 | "type": "object", |
| 6182 | "required": ["doc"], |
| 6183 | "properties": { |
| 6184 | "doc": { "$ref": "#/components/schemas/DocDetail" } |
| 6185 | } |
| 6186 | } |
| 6187 | } |
| 6188 | }, |
| 6189 | "CreateDocInput": { |
| 6190 | "type": "object", |
| 6191 | "properties": { |
| 6192 | "title": { "type": "string", "maxLength": 120 }, |
| 6193 | "content": { "type": "object", "description": "PagedDocContent structure" }, |
| 6194 | "layout": { |
| 6195 | "type": "object", |
| 6196 | "properties": { |
| 6197 | "orientation": { "type": "string", "enum": ["portrait", "landscape"] }, |
| 6198 | "margins": { "type": "string", "enum": ["normal", "narrow", "wide"] }, |
| 6199 | "backgroundColor": { "type": "string", "nullable": true }, |
| 6200 | "showPageNumbers": { "type": "boolean" } |
| 6201 | } |
| 6202 | }, |
| 6203 | "driveId": { "type": "string" }, |
| 6204 | "parentId": { "type": "string", "nullable": true } |
| 6205 | } |
| 6206 | }, |
| 6207 | "UpdateDocInput": { |
| 6208 | "type": "object", |
| 6209 | "properties": { |
| 6210 | "title": { "type": "string", "maxLength": 120 }, |
| 6211 | "content": { "type": "object", "description": "PagedDocContent structure" }, |
| 6212 | "layout": { |
| 6213 | "type": "object", |
| 6214 | "properties": { |
| 6215 | "orientation": { "type": "string", "enum": ["portrait", "landscape"] }, |
| 6216 | "margins": { "type": "string", "enum": ["normal", "narrow", "wide"] }, |
| 6217 | "backgroundColor": { "type": "string", "nullable": true }, |
| 6218 | "showPageNumbers": { "type": "boolean" } |
| 6219 | } |
| 6220 | } |
| 6221 | } |
| 6222 | }, |
| 6223 | "DriveMountSummary": { |
| 6224 | "type": "object", |
| 6225 | "required": ["type", "syncStatus"], |
| 6226 | "properties": { |
| 6227 | "type": { "type": "string", "enum": ["native", "integration"] }, |
| 6228 | "providerKey": { "type": "string", "nullable": true }, |
| 6229 | "syncStatus": { "type": "string", "enum": ["idle", "syncing", "errored", "disabled"] } |
| 6230 | } |
| 6231 | }, |
| 6232 | "DriveSummary": { |
| 6233 | "type": "object", |
| 6234 | "required": ["id", "name", "slug", "kind", "accessMode", "isDefault", "mount", "createdAt", "updatedAt"], |
| 6235 | "properties": { |
| 6236 | "id": { "type": "string" }, |
| 6237 | "name": { "type": "string" }, |
| 6238 | "slug": { "type": "string" }, |
| 6239 | "kind": { "type": "string", "enum": ["personal", "shared"] }, |
| 6240 | "accessMode": { "type": "string", "enum": ["workspace_default", "restricted"] }, |
| 6241 | "isDefault": { "type": "boolean" }, |
| 6242 | "ownerUserId": { "type": "string", "nullable": true }, |
| 6243 | "mount": { "$ref": "#/components/schemas/DriveMountSummary" }, |
| 6244 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6245 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6246 | } |
| 6247 | }, |
| 6248 | "ListWorkspaceDrivesResponse": { |
| 6249 | "type": "object", |
| 6250 | "required": ["data"], |
| 6251 | "properties": { |
| 6252 | "data": { |
| 6253 | "type": "object", |
| 6254 | "required": ["drives"], |
| 6255 | "properties": { |
| 6256 | "drives": { |
| 6257 | "type": "array", |
| 6258 | "items": { "$ref": "#/components/schemas/DriveSummary" } |
| 6259 | } |
| 6260 | } |
| 6261 | } |
| 6262 | } |
| 6263 | }, |
| 6264 | "DriveFileSummary": { |
| 6265 | "type": "object", |
| 6266 | "required": ["id", "driveId", "name", "fileType", "createdAt", "updatedAt"], |
| 6267 | "properties": { |
| 6268 | "id": { "type": "string" }, |
| 6269 | "driveId": { "type": "string" }, |
| 6270 | "parentId": { "type": "string", "nullable": true }, |
| 6271 | "name": { "type": "string" }, |
| 6272 | "fileType": { "type": "string" }, |
| 6273 | "mimeType": { "type": "string", "nullable": true }, |
| 6274 | "sizeBytes": { "type": "integer", "nullable": true }, |
| 6275 | "color": { "type": "string", "nullable": true }, |
| 6276 | "createdByUserId": { "type": "string", "nullable": true }, |
| 6277 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6278 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6279 | } |
| 6280 | }, |
| 6281 | "ListDriveFilesResponse": { |
| 6282 | "type": "object", |
| 6283 | "required": ["data"], |
| 6284 | "properties": { |
| 6285 | "data": { |
| 6286 | "type": "object", |
| 6287 | "required": ["files", "page"], |
| 6288 | "properties": { |
| 6289 | "files": { |
| 6290 | "type": "array", |
| 6291 | "items": { "$ref": "#/components/schemas/DriveFileSummary" } |
| 6292 | }, |
| 6293 | "page": { "$ref": "#/components/schemas/PaginationInfo" } |
| 6294 | } |
| 6295 | } |
| 6296 | } |
| 6297 | }, |
| 6298 | "FileDetail": { |
| 6299 | "type": "object", |
| 6300 | "required": ["id", "driveId", "name", "fileType", "accessMode", "isTrashed", "createdAt", "updatedAt"], |
| 6301 | "properties": { |
| 6302 | "id": { "type": "string" }, |
| 6303 | "driveId": { "type": "string" }, |
| 6304 | "parentId": { "type": "string", "nullable": true }, |
| 6305 | "name": { "type": "string" }, |
| 6306 | "fileType": { "type": "string" }, |
| 6307 | "mimeType": { "type": "string", "nullable": true }, |
| 6308 | "sizeBytes": { "type": "integer", "nullable": true }, |
| 6309 | "color": { "type": "string", "nullable": true }, |
| 6310 | "accessMode": { "type": "string" }, |
| 6311 | "isTrashed": { "type": "boolean" }, |
| 6312 | "createdByUserId": { "type": "string", "nullable": true }, |
| 6313 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6314 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6315 | } |
| 6316 | }, |
| 6317 | "FileDetailResponse": { |
| 6318 | "type": "object", |
| 6319 | "required": ["data"], |
| 6320 | "properties": { |
| 6321 | "data": { |
| 6322 | "type": "object", |
| 6323 | "required": ["file"], |
| 6324 | "properties": { |
| 6325 | "file": { "$ref": "#/components/schemas/FileDetail" } |
| 6326 | } |
| 6327 | } |
| 6328 | } |
| 6329 | }, |
| 6330 | "UpdateFileInput": { |
| 6331 | "type": "object", |
| 6332 | "properties": { |
| 6333 | "name": { "type": "string", "maxLength": 120 }, |
| 6334 | "parentId": { "type": "string", "nullable": true }, |
| 6335 | "color": { |
| 6336 | "type": "string", |
| 6337 | "enum": ["red", "orange", "yellow", "green", "blue", "purple", "pink", "gray"], |
| 6338 | "nullable": true |
| 6339 | } |
| 6340 | } |
| 6341 | }, |
| 6342 | "CalendarEventLinkInput": { |
| 6343 | "type": "object", |
| 6344 | "required": ["linkType"], |
| 6345 | "properties": { |
| 6346 | "linkType": { "type": "string", "enum": ["file", "channel", "url"] }, |
| 6347 | "fileId": { "type": "string" }, |
| 6348 | "channelId": { "type": "string" }, |
| 6349 | "url": { "type": "string", "format": "uri" }, |
| 6350 | "label": { "type": "string", "maxLength": 200, "nullable": true } |
| 6351 | }, |
| 6352 | "description": "Discriminated by linkType: file requires fileId, channel requires channelId, url requires url" |
| 6353 | }, |
| 6354 | "CalendarRecurrenceRule": { |
| 6355 | "type": "object", |
| 6356 | "required": ["frequency", "interval"], |
| 6357 | "properties": { |
| 6358 | "frequency": { "type": "string", "enum": ["daily", "weekly", "monthly", "yearly"] }, |
| 6359 | "interval": { "type": "integer", "minimum": 1, "maximum": 99 }, |
| 6360 | "byDay": { |
| 6361 | "type": "array", |
| 6362 | "items": { "type": "string", "enum": ["MO", "TU", "WE", "TH", "FR", "SA", "SU"] }, |
| 6363 | "maxItems": 7 |
| 6364 | }, |
| 6365 | "count": { "type": "integer", "minimum": 1, "maximum": 999 }, |
| 6366 | "until": { "type": "string", "format": "date-time" } |
| 6367 | } |
| 6368 | }, |
| 6369 | "CreateCalendarEventInput": { |
| 6370 | "type": "object", |
| 6371 | "required": ["title", "startsAt", "endsAt", "timeZone"], |
| 6372 | "properties": { |
| 6373 | "title": { "type": "string", "minLength": 1, "maxLength": 200 }, |
| 6374 | "description": { "type": "string", "maxLength": 4000, "nullable": true }, |
| 6375 | "location": { "type": "string", "maxLength": 300, "nullable": true }, |
| 6376 | "startsAt": { "type": "string", "format": "date-time" }, |
| 6377 | "endsAt": { "type": "string", "format": "date-time" }, |
| 6378 | "timeZone": { "type": "string", "minLength": 1, "maxLength": 100 }, |
| 6379 | "isAllDay": { "type": "boolean" }, |
| 6380 | "visibility": { "type": "string", "enum": ["private", "invitees", "workspace"] }, |
| 6381 | "attendeeUserIds": { "type": "array", "items": { "type": "string" }, "maxItems": 50 }, |
| 6382 | "linkInputs": { |
| 6383 | "type": "array", |
| 6384 | "items": { "$ref": "#/components/schemas/CalendarEventLinkInput" }, |
| 6385 | "maxItems": 20 |
| 6386 | }, |
| 6387 | "recurrenceRule": { |
| 6388 | "oneOf": [ |
| 6389 | { "$ref": "#/components/schemas/CalendarRecurrenceRule" }, |
| 6390 | { "type": "null" } |
| 6391 | ] |
| 6392 | } |
| 6393 | } |
| 6394 | }, |
| 6395 | "UpdateCalendarEventInput": { |
| 6396 | "type": "object", |
| 6397 | "properties": { |
| 6398 | "title": { "type": "string", "minLength": 1, "maxLength": 200 }, |
| 6399 | "description": { "type": "string", "maxLength": 4000, "nullable": true }, |
| 6400 | "location": { "type": "string", "maxLength": 300, "nullable": true }, |
| 6401 | "startsAt": { "type": "string", "format": "date-time" }, |
| 6402 | "endsAt": { "type": "string", "format": "date-time" }, |
| 6403 | "timeZone": { "type": "string", "minLength": 1, "maxLength": 100 }, |
| 6404 | "isAllDay": { "type": "boolean" }, |
| 6405 | "visibility": { "type": "string", "enum": ["private", "invitees", "workspace"] }, |
| 6406 | "status": { "type": "string", "enum": ["active", "canceled"] }, |
| 6407 | "attendeeUserIds": { "type": "array", "items": { "type": "string" }, "maxItems": 50 }, |
| 6408 | "linkInputs": { |
| 6409 | "type": "array", |
| 6410 | "items": { "$ref": "#/components/schemas/CalendarEventLinkInput" }, |
| 6411 | "maxItems": 20 |
| 6412 | }, |
| 6413 | "recurrenceRule": { |
| 6414 | "oneOf": [ |
| 6415 | { "$ref": "#/components/schemas/CalendarRecurrenceRule" }, |
| 6416 | { "type": "null" } |
| 6417 | ] |
| 6418 | } |
| 6419 | } |
| 6420 | }, |
| 6421 | "ListCalendarEventsResponse": { |
| 6422 | "type": "object", |
| 6423 | "required": ["data"], |
| 6424 | "properties": { |
| 6425 | "data": { |
| 6426 | "type": "object", |
| 6427 | "description": "Calendar events data as returned by the calendar server library" |
| 6428 | } |
| 6429 | } |
| 6430 | }, |
| 6431 | "CalendarEventDetailResponse": { |
| 6432 | "type": "object", |
| 6433 | "required": ["data"], |
| 6434 | "properties": { |
| 6435 | "data": { |
| 6436 | "type": "object", |
| 6437 | "description": "Calendar event detail as returned by the calendar server library" |
| 6438 | } |
| 6439 | } |
| 6440 | }, |
| 6441 | "WorkspaceSearchInput": { |
| 6442 | "type": "object", |
| 6443 | "required": ["query"], |
| 6444 | "properties": { |
| 6445 | "query": { "type": "string", "minLength": 1, "maxLength": 400 }, |
| 6446 | "sourceKinds": { |
| 6447 | "type": "array", |
| 6448 | "items": { |
| 6449 | "type": "string", |
| 6450 | "enum": ["file", "task", "container_message", "kairo_message", "app_document"] |
| 6451 | }, |
| 6452 | "maxItems": 10 |
| 6453 | }, |
| 6454 | "limit": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 }, |
| 6455 | "cursor": { "type": "string" } |
| 6456 | } |
| 6457 | }, |
| 6458 | "WorkspaceSearchResponse": { |
| 6459 | "type": "object", |
| 6460 | "required": ["data"], |
| 6461 | "properties": { |
| 6462 | "data": { |
| 6463 | "type": "object", |
| 6464 | "description": "Search results as returned by the workspace search engine" |
| 6465 | } |
| 6466 | } |
| 6467 | }, |
| 6468 | "TaskboardStatus": { |
| 6469 | "type": "object", |
| 6470 | "required": ["id", "key", "name", "color", "isDefault", "isCompleted", "sortOrder"], |
| 6471 | "properties": { |
| 6472 | "id": { "type": "string" }, |
| 6473 | "key": { "type": "string" }, |
| 6474 | "name": { "type": "string" }, |
| 6475 | "color": { "type": "string" }, |
| 6476 | "isDefault": { "type": "boolean" }, |
| 6477 | "isCompleted": { "type": "boolean" }, |
| 6478 | "sortOrder": { "type": "integer" } |
| 6479 | } |
| 6480 | }, |
| 6481 | "TaskboardSummary": { |
| 6482 | "type": "object", |
| 6483 | "required": ["id", "name", "driveId", "statuses", "createdAt", "updatedAt"], |
| 6484 | "properties": { |
| 6485 | "id": { "type": "string" }, |
| 6486 | "name": { "type": "string" }, |
| 6487 | "driveId": { "type": "string" }, |
| 6488 | "color": { "type": "string", "nullable": true }, |
| 6489 | "identifierPrefix": { "type": "string", "nullable": true }, |
| 6490 | "description": { "type": "string", "nullable": true }, |
| 6491 | "defaultView": { "type": "string", "nullable": true }, |
| 6492 | "statuses": { |
| 6493 | "type": "array", |
| 6494 | "items": { "$ref": "#/components/schemas/TaskboardStatus" } |
| 6495 | }, |
| 6496 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6497 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6498 | } |
| 6499 | }, |
| 6500 | "ListWorkspaceTaskboardsResponse": { |
| 6501 | "type": "object", |
| 6502 | "required": ["data"], |
| 6503 | "properties": { |
| 6504 | "data": { |
| 6505 | "type": "object", |
| 6506 | "required": ["taskboards"], |
| 6507 | "properties": { |
| 6508 | "taskboards": { |
| 6509 | "type": "array", |
| 6510 | "items": { "$ref": "#/components/schemas/TaskboardSummary" } |
| 6511 | } |
| 6512 | } |
| 6513 | } |
| 6514 | } |
| 6515 | }, |
| 6516 | "TaskAssignee": { |
| 6517 | "type": "object", |
| 6518 | "required": ["id", "email"], |
| 6519 | "properties": { |
| 6520 | "id": { "type": "string" }, |
| 6521 | "firstName": { "type": "string", "nullable": true }, |
| 6522 | "lastName": { "type": "string", "nullable": true }, |
| 6523 | "avatarUrl": { "type": "string", "nullable": true }, |
| 6524 | "email": { "type": "string", "format": "email" } |
| 6525 | } |
| 6526 | }, |
| 6527 | "TaskStatusInfo": { |
| 6528 | "type": "object", |
| 6529 | "required": ["id", "key", "name", "color", "isCompleted"], |
| 6530 | "properties": { |
| 6531 | "id": { "type": "string" }, |
| 6532 | "key": { "type": "string" }, |
| 6533 | "name": { "type": "string" }, |
| 6534 | "color": { "type": "string" }, |
| 6535 | "isCompleted": { "type": "boolean" } |
| 6536 | } |
| 6537 | }, |
| 6538 | "TaskSummary": { |
| 6539 | "type": "object", |
| 6540 | "required": ["id", "taskboardId", "taskNumber", "title", "priority", "labels", "assignees", "isCompleted", "createdAt", "updatedAt"], |
| 6541 | "properties": { |
| 6542 | "id": { "type": "string" }, |
| 6543 | "taskboardId": { "type": "string" }, |
| 6544 | "taskNumber": { "type": "integer" }, |
| 6545 | "identifier": { "type": "string", "nullable": true, "description": "Human-readable identifier like PREFIX-123" }, |
| 6546 | "title": { "type": "string" }, |
| 6547 | "description": { "type": "string", "nullable": true }, |
| 6548 | "status": { |
| 6549 | "oneOf": [ |
| 6550 | { "$ref": "#/components/schemas/TaskStatusInfo" }, |
| 6551 | { "type": "null" } |
| 6552 | ] |
| 6553 | }, |
| 6554 | "priority": { "type": "string", "enum": ["none", "low", "medium", "high", "urgent"] }, |
| 6555 | "labels": { "type": "array", "items": { "type": "string" } }, |
| 6556 | "dueDate": { "type": "string", "format": "date-time", "nullable": true }, |
| 6557 | "assignees": { |
| 6558 | "type": "array", |
| 6559 | "items": { "$ref": "#/components/schemas/TaskAssignee" } |
| 6560 | }, |
| 6561 | "isCompleted": { "type": "boolean" }, |
| 6562 | "completedAt": { "type": "string", "format": "date-time", "nullable": true }, |
| 6563 | "createdByUserId": { "type": "string", "nullable": true }, |
| 6564 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6565 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6566 | } |
| 6567 | }, |
| 6568 | "ListTaskboardTasksResponse": { |
| 6569 | "type": "object", |
| 6570 | "required": ["data"], |
| 6571 | "properties": { |
| 6572 | "data": { |
| 6573 | "type": "object", |
| 6574 | "required": ["tasks"], |
| 6575 | "properties": { |
| 6576 | "tasks": { |
| 6577 | "type": "array", |
| 6578 | "items": { "$ref": "#/components/schemas/TaskSummary" } |
| 6579 | } |
| 6580 | } |
| 6581 | } |
| 6582 | } |
| 6583 | }, |
| 6584 | "CreateTaskInput": { |
| 6585 | "type": "object", |
| 6586 | "required": ["title"], |
| 6587 | "properties": { |
| 6588 | "title": { "type": "string", "minLength": 1, "maxLength": 500 }, |
| 6589 | "description": { "type": "string", "maxLength": 50000 }, |
| 6590 | "statusId": { "type": "string", "description": "Status ID (defaults to the board's default status)" }, |
| 6591 | "priority": { "type": "string", "enum": ["none", "low", "medium", "high", "urgent"] }, |
| 6592 | "dueDate": { "type": "string", "format": "date-time", "nullable": true }, |
| 6593 | "labels": { "type": "array", "items": { "type": "string", "maxLength": 100 }, "maxItems": 20 }, |
| 6594 | "assigneeUserIds": { "type": "array", "items": { "type": "string" }, "maxItems": 20 } |
| 6595 | } |
| 6596 | }, |
| 6597 | "CreateTaskResponse": { |
| 6598 | "type": "object", |
| 6599 | "required": ["data"], |
| 6600 | "properties": { |
| 6601 | "data": { |
| 6602 | "type": "object", |
| 6603 | "required": ["task"], |
| 6604 | "properties": { |
| 6605 | "task": { |
| 6606 | "type": "object", |
| 6607 | "required": ["id", "taskboardId", "title", "statusId", "priority", "labels", "createdAt", "updatedAt"], |
| 6608 | "properties": { |
| 6609 | "id": { "type": "string" }, |
| 6610 | "taskboardId": { "type": "string" }, |
| 6611 | "title": { "type": "string" }, |
| 6612 | "description": { "type": "string" }, |
| 6613 | "statusId": { "type": "string" }, |
| 6614 | "priority": { "type": "string", "enum": ["none", "low", "medium", "high", "urgent"] }, |
| 6615 | "labels": { "type": "array", "items": { "type": "string" } }, |
| 6616 | "dueDate": { "type": "string", "format": "date-time", "nullable": true }, |
| 6617 | "assigneeUserIds": { "type": "array", "items": { "type": "string" } }, |
| 6618 | "createdByUserId": { "type": "string" }, |
| 6619 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6620 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6621 | } |
| 6622 | } |
| 6623 | } |
| 6624 | } |
| 6625 | } |
| 6626 | }, |
| 6627 | "UpdateTaskInput": { |
| 6628 | "type": "object", |
| 6629 | "properties": { |
| 6630 | "title": { "type": "string", "minLength": 1, "maxLength": 500 }, |
| 6631 | "description": { "type": "string", "maxLength": 50000 }, |
| 6632 | "statusId": { "type": "string" }, |
| 6633 | "priority": { "type": "string", "enum": ["none", "low", "medium", "high", "urgent"] }, |
| 6634 | "dueDate": { "type": "string", "format": "date-time", "nullable": true }, |
| 6635 | "labels": { "type": "array", "items": { "type": "string", "maxLength": 100 }, "maxItems": 20 }, |
| 6636 | "assigneeUserIds": { "type": "array", "items": { "type": "string" }, "maxItems": 20 } |
| 6637 | } |
| 6638 | }, |
| 6639 | "ChannelSummary": { |
| 6640 | "type": "object", |
| 6641 | "required": ["id", "name", "slug", "type", "isDefault", "createdAt", "updatedAt"], |
| 6642 | "properties": { |
| 6643 | "id": { "type": "string" }, |
| 6644 | "name": { "type": "string" }, |
| 6645 | "slug": { "type": "string" }, |
| 6646 | "description": { "type": "string", "nullable": true }, |
| 6647 | "topic": { "type": "string", "nullable": true }, |
| 6648 | "type": { "type": "string", "enum": ["public", "private"] }, |
| 6649 | "isDefault": { "type": "boolean" }, |
| 6650 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6651 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6652 | } |
| 6653 | }, |
| 6654 | "ChannelListResponse": { |
| 6655 | "type": "object", |
| 6656 | "required": ["channels"], |
| 6657 | "properties": { |
| 6658 | "channels": { |
| 6659 | "type": "array", |
| 6660 | "items": { "$ref": "#/components/schemas/ChannelSummary" } |
| 6661 | } |
| 6662 | } |
| 6663 | }, |
| 6664 | "DmMemberSummary": { |
| 6665 | "type": "object", |
| 6666 | "required": ["userId", "email"], |
| 6667 | "properties": { |
| 6668 | "userId": { "type": "string" }, |
| 6669 | "firstName": { "type": "string", "nullable": true }, |
| 6670 | "lastName": { "type": "string", "nullable": true }, |
| 6671 | "email": { "type": "string", "format": "email" } |
| 6672 | } |
| 6673 | }, |
| 6674 | "DmSummary": { |
| 6675 | "type": "object", |
| 6676 | "required": ["id", "isGroup", "members", "createdAt", "updatedAt"], |
| 6677 | "properties": { |
| 6678 | "id": { "type": "string" }, |
| 6679 | "isGroup": { "type": "boolean" }, |
| 6680 | "name": { "type": "string", "nullable": true }, |
| 6681 | "members": { |
| 6682 | "type": "array", |
| 6683 | "items": { "$ref": "#/components/schemas/DmMemberSummary" } |
| 6684 | }, |
| 6685 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6686 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6687 | } |
| 6688 | }, |
| 6689 | "DmListResponse": { |
| 6690 | "type": "object", |
| 6691 | "required": ["dms"], |
| 6692 | "properties": { |
| 6693 | "dms": { |
| 6694 | "type": "array", |
| 6695 | "items": { "$ref": "#/components/schemas/DmSummary" } |
| 6696 | } |
| 6697 | } |
| 6698 | }, |
| 6699 | "MessageTextPart": { |
| 6700 | "type": "object", |
| 6701 | "required": ["type", "text"], |
| 6702 | "properties": { |
| 6703 | "type": { "type": "string", "enum": ["text"] }, |
| 6704 | "text": { "type": "string" } |
| 6705 | } |
| 6706 | }, |
| 6707 | "MessageMentionPart": { |
| 6708 | "type": "object", |
| 6709 | "required": ["type", "userId", "displayName"], |
| 6710 | "properties": { |
| 6711 | "type": { "type": "string", "enum": ["mention"] }, |
| 6712 | "userId": { "type": "string" }, |
| 6713 | "displayName": { "type": "string" } |
| 6714 | } |
| 6715 | }, |
| 6716 | "MessageContentPart": { |
| 6717 | "oneOf": [ |
| 6718 | { "$ref": "#/components/schemas/MessageTextPart" }, |
| 6719 | { "$ref": "#/components/schemas/MessageMentionPart" } |
| 6720 | ], |
| 6721 | "discriminator": { |
| 6722 | "propertyName": "type" |
| 6723 | } |
| 6724 | }, |
| 6725 | "ContainerMessageSummary": { |
| 6726 | "type": "object", |
| 6727 | "required": ["id", "messageKind", "plaintext", "content", "createdAt", "updatedAt"], |
| 6728 | "properties": { |
| 6729 | "id": { "type": "string" }, |
| 6730 | "authorUserId": { "type": "string", "nullable": true }, |
| 6731 | "messageKind": { "type": "string" }, |
| 6732 | "plaintext": { "type": "string" }, |
| 6733 | "content": { |
| 6734 | "type": "array", |
| 6735 | "items": { "$ref": "#/components/schemas/MessageContentPart" } |
| 6736 | }, |
| 6737 | "replyToMessageId": { "type": "string", "nullable": true }, |
| 6738 | "editedAt": { "type": "string", "format": "date-time", "nullable": true }, |
| 6739 | "createdAt": { "type": "string", "format": "date-time" }, |
| 6740 | "updatedAt": { "type": "string", "format": "date-time" } |
| 6741 | } |
| 6742 | }, |
| 6743 | "MessagesPage": { |
| 6744 | "type": "object", |
| 6745 | "required": ["limit", "hasMore", "nextCursor"], |
| 6746 | "properties": { |
| 6747 | "limit": { "type": "integer" }, |
| 6748 | "hasMore": { "type": "boolean" }, |
| 6749 | "nextCursor": { "type": "string", "nullable": true } |
| 6750 | } |
| 6751 | }, |
| 6752 | "MessagesListResponse": { |
| 6753 | "type": "object", |
| 6754 | "required": ["messages", "page"], |
| 6755 | "properties": { |
| 6756 | "messages": { |
| 6757 | "type": "array", |
| 6758 | "items": { "$ref": "#/components/schemas/ContainerMessageSummary" } |
| 6759 | }, |
| 6760 | "page": { "$ref": "#/components/schemas/MessagesPage" } |
| 6761 | } |
| 6762 | }, |
| 6763 | "SendMessageInput": { |
| 6764 | "type": "object", |
| 6765 | "required": ["content"], |
| 6766 | "properties": { |
| 6767 | "content": { |
| 6768 | "type": "array", |
| 6769 | "items": { "$ref": "#/components/schemas/MessageContentPart" }, |
| 6770 | "minItems": 1, |
| 6771 | "maxItems": 500 |
| 6772 | }, |
| 6773 | "replyToMessageId": { "type": "string", "nullable": true }, |
| 6774 | "threadRootMessageId": { "type": "string", "nullable": true } |
| 6775 | } |
| 6776 | }, |
| 6777 | "SendMessageResponse": { |
| 6778 | "type": "object", |
| 6779 | "required": ["message"], |
| 6780 | "properties": { |
| 6781 | "message": { "$ref": "#/components/schemas/ContainerMessageSummary" } |
| 6782 | } |
| 6783 | }, |
| 6784 | "MessageDetailResponse": { |
| 6785 | "type": "object", |
| 6786 | "required": ["message"], |
| 6787 | "properties": { |
| 6788 | "message": { |
| 6789 | "allOf": [ |
| 6790 | { "$ref": "#/components/schemas/ContainerMessageSummary" }, |
| 6791 | { |
| 6792 | "type": "object", |
| 6793 | "properties": { |
| 6794 | "containerType": { "type": "string" }, |
| 6795 | "containerId": { "type": "string" } |
| 6796 | } |
| 6797 | } |
| 6798 | ] |
| 6799 | } |
| 6800 | } |
| 6801 | }, |
| 6802 | "EditMessageInput": { |
| 6803 | "type": "object", |
| 6804 | "required": ["content"], |
| 6805 | "properties": { |
| 6806 | "content": { |
| 6807 | "type": "array", |
| 6808 | "items": { "$ref": "#/components/schemas/MessageContentPart" }, |
| 6809 | "minItems": 1, |
| 6810 | "maxItems": 500 |
| 6811 | } |
| 6812 | } |
| 6813 | }, |
| 6814 | "ThreadResponse": { |
| 6815 | "type": "object", |
| 6816 | "required": ["rootMessage", "replies"], |
| 6817 | "properties": { |
| 6818 | "rootMessage": { |
| 6819 | "allOf": [ |
| 6820 | { "$ref": "#/components/schemas/ContainerMessageSummary" }, |
| 6821 | { |
| 6822 | "type": "object", |
| 6823 | "properties": { |
| 6824 | "containerType": { "type": "string" }, |
| 6825 | "containerId": { "type": "string" } |
| 6826 | } |
| 6827 | } |
| 6828 | ] |
| 6829 | }, |
| 6830 | "replies": { |
| 6831 | "type": "array", |
| 6832 | "items": { "$ref": "#/components/schemas/ContainerMessageSummary" } |
| 6833 | } |
| 6834 | } |
| 6835 | }, |
| 6836 | "ThreadReplyInput": { |
| 6837 | "type": "object", |
| 6838 | "required": ["content"], |
| 6839 | "properties": { |
| 6840 | "content": { |
| 6841 | "type": "array", |
| 6842 | "items": { "$ref": "#/components/schemas/MessageContentPart" }, |
| 6843 | "minItems": 1, |
| 6844 | "maxItems": 500 |
| 6845 | } |
| 6846 | } |
| 6847 | }, |
| 6848 | "ReactionResponse": { |
| 6849 | "type": "object", |
| 6850 | "required": ["messageId", "emoji", "count"], |
| 6851 | "properties": { |
| 6852 | "messageId": { "type": "string" }, |
| 6853 | "emoji": { "type": "string" }, |
| 6854 | "count": { "type": "integer" } |
| 6855 | } |
| 6856 | }, |
| 6857 | "PinResponse": { |
| 6858 | "type": "object", |
| 6859 | "required": ["messageId", "pinned"], |
| 6860 | "properties": { |
| 6861 | "messageId": { "type": "string" }, |
| 6862 | "pinned": { "type": "boolean" } |
| 6863 | } |
| 6864 | } |
| 6865 | } |
| 6866 | } |
| 6867 | } |
| 6868 |