2996 lines · 73 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.
| 5 | "version": "1.0.0-beta", |
| 6 | "summary": "Workspace-native app registry, install, and runtime APIs for Coline.", |
| 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": "Workspace installs", |
| 30 | "description": "Workspace app install and permission APIs." |
| 31 | }, |
| 32 | { |
| 33 | "name": "Runtime", |
| 34 | "description": "Installed app file, index, notification, and ambient APIs." |
| 35 | } |
| 36 | ], |
| 37 | "paths": { |
| 38 | "/api/v1/apps": { |
| 39 | "get": { |
| 40 | "tags": [ |
| 41 | "Store" |
| 42 | ], |
| 43 | "summary": "List store apps", |
| 44 | "operationId": "listStoreApps", |
| 45 | "responses": { |
| 46 | "200": { |
| 47 | "description": "Store apps", |
| 48 | "content": { |
| 49 | "application/json": { |
| 50 | "schema": { |
| 51 | "$ref": "#/components/schemas/StoreAppsResponse" |
| 52 | } |
| 53 | } |
| 54 | } |
| 55 | } |
| 56 | } |
| 57 | }, |
| 58 | "post": { |
| 59 | "tags": [ |
| 60 | "Publisher" |
| 61 | ], |
| 62 | "summary": "Register a new app and initial release", |
| 63 | "operationId": "registerApp", |
| 64 | "security": [ |
| 65 | { |
| 66 | "bearerAuth": [] |
| 67 | } |
| 68 | ], |
| 69 | "requestBody": { |
| 70 | "required": true, |
| 71 | "content": { |
| 72 | "application/json": { |
| 73 | "schema": { |
| 74 | "$ref": "#/components/schemas/RegisterAppInput" |
| 75 | } |
| 76 | } |
| 77 | } |
| 78 | }, |
| 79 | "responses": { |
| 80 | "201": { |
| 81 | "description": "Registered app", |
| 82 | "content": { |
| 83 | "application/json": { |
| 84 | "schema": { |
| 85 | "$ref": "#/components/schemas/AppVersionMutationResponse" |
| 86 | } |
| 87 | } |
| 88 | } |
| 89 | } |
| 90 | } |
| 91 | } |
| 92 | }, |
| 93 | "/api/v1/apps/{appKey}": { |
| 94 | "get": { |
| 95 | "tags": [ |
| 96 | "Store" |
| 97 | ], |
| 98 | "summary": "Get a store app", |
| 99 | "operationId": "getStoreApp", |
| 100 | "parameters": [ |
| 101 | { |
| 102 | "name": "appKey", |
| 103 | "in": "path", |
| 104 | "required": true, |
| 105 | "schema": { |
| 106 | "type": "string" |
| 107 | } |
| 108 | } |
| 109 | ], |
| 110 | "responses": { |
| 111 | "200": { |
| 112 | "description": "Store app detail", |
| 113 | "content": { |
| 114 | "application/json": { |
| 115 | "schema": { |
| 116 | "$ref": "#/components/schemas/StoreAppResponse" |
| 117 | } |
| 118 | } |
| 119 | } |
| 120 | }, |
| 121 | "404": { |
| 122 | "description": "App not found", |
| 123 | "content": { |
| 124 | "application/json": { |
| 125 | "schema": { |
| 126 | "$ref": "#/components/schemas/ErrorEnvelope" |
| 127 | } |
| 128 | } |
| 129 | } |
| 130 | } |
| 131 | } |
| 132 | } |
| 133 | }, |
| 134 | "/api/v1/apps/{appKey}/versions": { |
| 135 | "get": { |
| 136 | "tags": [ |
| 137 | "Store" |
| 138 | ], |
| 139 | "summary": "List approved versions for a store app", |
| 140 | "operationId": "listStoreAppVersions", |
| 141 | "parameters": [ |
| 142 | { |
| 143 | "name": "appKey", |
| 144 | "in": "path", |
| 145 | "required": true, |
| 146 | "schema": { |
| 147 | "type": "string" |
| 148 | } |
| 149 | } |
| 150 | ], |
| 151 | "responses": { |
| 152 | "200": { |
| 153 | "description": "Approved store app versions", |
| 154 | "content": { |
| 155 | "application/json": { |
| 156 | "schema": { |
| 157 | "$ref": "#/components/schemas/StoreAppVersionsResponse" |
| 158 | } |
| 159 | } |
| 160 | } |
| 161 | } |
| 162 | } |
| 163 | }, |
| 164 | "post": { |
| 165 | "tags": [ |
| 166 | "Publisher" |
| 167 | ], |
| 168 | "summary": "Create a new app version", |
| 169 | "operationId": "createAppVersion", |
| 170 | "security": [ |
| 171 | { |
| 172 | "bearerAuth": [] |
| 173 | } |
| 174 | ], |
| 175 | "parameters": [ |
| 176 | { |
| 177 | "name": "appKey", |
| 178 | "in": "path", |
| 179 | "required": true, |
| 180 | "schema": { |
| 181 | "type": "string" |
| 182 | } |
| 183 | } |
| 184 | ], |
| 185 | "requestBody": { |
| 186 | "required": true, |
| 187 | "content": { |
| 188 | "application/json": { |
| 189 | "schema": { |
| 190 | "$ref": "#/components/schemas/RegisterAppInput" |
| 191 | } |
| 192 | } |
| 193 | } |
| 194 | }, |
| 195 | "responses": { |
| 196 | "201": { |
| 197 | "description": "Created app version", |
| 198 | "content": { |
| 199 | "application/json": { |
| 200 | "schema": { |
| 201 | "$ref": "#/components/schemas/AppVersionMutationResponse" |
| 202 | } |
| 203 | } |
| 204 | } |
| 205 | } |
| 206 | } |
| 207 | } |
| 208 | }, |
| 209 | "/api/v1/apps/{appKey}/versions/{versionId}/submit": { |
| 210 | "post": { |
| 211 | "tags": [ |
| 212 | "Publisher" |
| 213 | ], |
| 214 | "summary": "Submit an app version for review", |
| 215 | "operationId": "submitAppVersionForReview", |
| 216 | "security": [ |
| 217 | { |
| 218 | "bearerAuth": [] |
| 219 | } |
| 220 | ], |
| 221 | "parameters": [ |
| 222 | { |
| 223 | "name": "appKey", |
| 224 | "in": "path", |
| 225 | "required": true, |
| 226 | "schema": { |
| 227 | "type": "string" |
| 228 | } |
| 229 | }, |
| 230 | { |
| 231 | "name": "versionId", |
| 232 | "in": "path", |
| 233 | "required": true, |
| 234 | "schema": { |
| 235 | "type": "string" |
| 236 | } |
| 237 | } |
| 238 | ], |
| 239 | "requestBody": { |
| 240 | "required": true, |
| 241 | "content": { |
| 242 | "application/json": { |
| 243 | "schema": { |
| 244 | "type": "object", |
| 245 | "properties": { |
| 246 | "storeListed": { |
| 247 | "type": "boolean" |
| 248 | } |
| 249 | } |
| 250 | } |
| 251 | } |
| 252 | } |
| 253 | }, |
| 254 | "responses": { |
| 255 | "200": { |
| 256 | "description": "Submitted app version", |
| 257 | "content": { |
| 258 | "application/json": { |
| 259 | "schema": { |
| 260 | "$ref": "#/components/schemas/SubmitAppVersionForReviewResponse" |
| 261 | } |
| 262 | } |
| 263 | } |
| 264 | } |
| 265 | } |
| 266 | } |
| 267 | }, |
| 268 | "/api/v1/workspaces/{workspaceSlug}/apps": { |
| 269 | "get": { |
| 270 | "tags": [ |
| 271 | "Workspace installs" |
| 272 | ], |
| 273 | "summary": "List installed apps and workspace-visible catalog", |
| 274 | "operationId": "listWorkspaceApps", |
| 275 | "security": [ |
| 276 | { |
| 277 | "bearerAuth": [] |
| 278 | } |
| 279 | ], |
| 280 | "parameters": [ |
| 281 | { |
| 282 | "name": "workspaceSlug", |
| 283 | "in": "path", |
| 284 | "required": true, |
| 285 | "schema": { |
| 286 | "type": "string" |
| 287 | } |
| 288 | } |
| 289 | ], |
| 290 | "responses": { |
| 291 | "200": { |
| 292 | "description": "Workspace app data", |
| 293 | "content": { |
| 294 | "application/json": { |
| 295 | "schema": { |
| 296 | "$ref": "#/components/schemas/WorkspaceAppsResponse" |
| 297 | } |
| 298 | } |
| 299 | } |
| 300 | } |
| 301 | } |
| 302 | }, |
| 303 | "post": { |
| 304 | "tags": [ |
| 305 | "Workspace installs" |
| 306 | ], |
| 307 | "summary": "Install an app into a workspace", |
| 308 | "operationId": "installWorkspaceApp", |
| 309 | "security": [ |
| 310 | { |
| 311 | "bearerAuth": [] |
| 312 | } |
| 313 | ], |
| 314 | "parameters": [ |
| 315 | { |
| 316 | "name": "workspaceSlug", |
| 317 | "in": "path", |
| 318 | "required": true, |
| 319 | "schema": { |
| 320 | "type": "string" |
| 321 | } |
| 322 | } |
| 323 | ], |
| 324 | "requestBody": { |
| 325 | "required": true, |
| 326 | "content": { |
| 327 | "application/json": { |
| 328 | "schema": { |
| 329 | "$ref": "#/components/schemas/InstallWorkspaceAppInput" |
| 330 | } |
| 331 | } |
| 332 | } |
| 333 | }, |
| 334 | "responses": { |
| 335 | "201": { |
| 336 | "description": "Installed app", |
| 337 | "content": { |
| 338 | "application/json": { |
| 339 | "schema": { |
| 340 | "$ref": "#/components/schemas/InstallWorkspaceAppResponse" |
| 341 | } |
| 342 | } |
| 343 | } |
| 344 | } |
| 345 | } |
| 346 | } |
| 347 | }, |
| 348 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}": { |
| 349 | "get": { |
| 350 | "tags": [ |
| 351 | "Workspace installs" |
| 352 | ], |
| 353 | "summary": "Get an installed workspace app", |
| 354 | "operationId": "getWorkspaceInstalledApp", |
| 355 | "security": [ |
| 356 | { |
| 357 | "bearerAuth": [] |
| 358 | } |
| 359 | ], |
| 360 | "parameters": [ |
| 361 | { |
| 362 | "name": "workspaceSlug", |
| 363 | "in": "path", |
| 364 | "required": true, |
| 365 | "schema": { |
| 366 | "type": "string" |
| 367 | } |
| 368 | }, |
| 369 | { |
| 370 | "name": "appKey", |
| 371 | "in": "path", |
| 372 | "required": true, |
| 373 | "schema": { |
| 374 | "type": "string" |
| 375 | } |
| 376 | } |
| 377 | ], |
| 378 | "responses": { |
| 379 | "200": { |
| 380 | "description": "Installed app", |
| 381 | "content": { |
| 382 | "application/json": { |
| 383 | "schema": { |
| 384 | "$ref": "#/components/schemas/WorkspaceInstalledAppResponse" |
| 385 | } |
| 386 | } |
| 387 | } |
| 388 | } |
| 389 | } |
| 390 | }, |
| 391 | "delete": { |
| 392 | "tags": [ |
| 393 | "Workspace installs" |
| 394 | ], |
| 395 | "summary": "Uninstall a workspace app", |
| 396 | "operationId": "uninstallWorkspaceApp", |
| 397 | "security": [ |
| 398 | { |
| 399 | "bearerAuth": [] |
| 400 | } |
| 401 | ], |
| 402 | "parameters": [ |
| 403 | { |
| 404 | "name": "workspaceSlug", |
| 405 | "in": "path", |
| 406 | "required": true, |
| 407 | "schema": { |
| 408 | "type": "string" |
| 409 | } |
| 410 | }, |
| 411 | { |
| 412 | "name": "appKey", |
| 413 | "in": "path", |
| 414 | "required": true, |
| 415 | "schema": { |
| 416 | "type": "string" |
| 417 | } |
| 418 | } |
| 419 | ], |
| 420 | "responses": { |
| 421 | "200": { |
| 422 | "description": "App uninstalled", |
| 423 | "content": { |
| 424 | "application/json": { |
| 425 | "schema": { |
| 426 | "$ref": "#/components/schemas/OkResponse" |
| 427 | } |
| 428 | } |
| 429 | } |
| 430 | } |
| 431 | } |
| 432 | } |
| 433 | }, |
| 434 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/permissions": { |
| 435 | "get": { |
| 436 | "tags": [ |
| 437 | "Workspace installs" |
| 438 | ], |
| 439 | "summary": "Get granted workspace app permissions", |
| 440 | "operationId": "getWorkspaceAppPermissions", |
| 441 | "security": [ |
| 442 | { |
| 443 | "bearerAuth": [] |
| 444 | } |
| 445 | ], |
| 446 | "parameters": [ |
| 447 | { |
| 448 | "name": "workspaceSlug", |
| 449 | "in": "path", |
| 450 | "required": true, |
| 451 | "schema": { |
| 452 | "type": "string" |
| 453 | } |
| 454 | }, |
| 455 | { |
| 456 | "name": "appKey", |
| 457 | "in": "path", |
| 458 | "required": true, |
| 459 | "schema": { |
| 460 | "type": "string" |
| 461 | } |
| 462 | } |
| 463 | ], |
| 464 | "responses": { |
| 465 | "200": { |
| 466 | "description": "Workspace app permissions", |
| 467 | "content": { |
| 468 | "application/json": { |
| 469 | "schema": { |
| 470 | "$ref": "#/components/schemas/WorkspaceAppPermissionsResponse" |
| 471 | } |
| 472 | } |
| 473 | } |
| 474 | } |
| 475 | } |
| 476 | }, |
| 477 | "put": { |
| 478 | "tags": [ |
| 479 | "Workspace installs" |
| 480 | ], |
| 481 | "summary": "Update granted workspace app permissions", |
| 482 | "operationId": "updateWorkspaceAppPermissions", |
| 483 | "security": [ |
| 484 | { |
| 485 | "bearerAuth": [] |
| 486 | } |
| 487 | ], |
| 488 | "parameters": [ |
| 489 | { |
| 490 | "name": "workspaceSlug", |
| 491 | "in": "path", |
| 492 | "required": true, |
| 493 | "schema": { |
| 494 | "type": "string" |
| 495 | } |
| 496 | }, |
| 497 | { |
| 498 | "name": "appKey", |
| 499 | "in": "path", |
| 500 | "required": true, |
| 501 | "schema": { |
| 502 | "type": "string" |
| 503 | } |
| 504 | } |
| 505 | ], |
| 506 | "requestBody": { |
| 507 | "required": true, |
| 508 | "content": { |
| 509 | "application/json": { |
| 510 | "schema": { |
| 511 | "type": "object", |
| 512 | "required": [ |
| 513 | "grantedPermissions" |
| 514 | ], |
| 515 | "properties": { |
| 516 | "grantedPermissions": { |
| 517 | "type": "array", |
| 518 | "items": { |
| 519 | "type": "string" |
| 520 | } |
| 521 | } |
| 522 | } |
| 523 | } |
| 524 | } |
| 525 | } |
| 526 | }, |
| 527 | "responses": { |
| 528 | "200": { |
| 529 | "description": "Updated permissions", |
| 530 | "content": { |
| 531 | "application/json": { |
| 532 | "schema": { |
| 533 | "$ref": "#/components/schemas/WorkspaceAppPermissionsResponse" |
| 534 | } |
| 535 | } |
| 536 | } |
| 537 | } |
| 538 | } |
| 539 | } |
| 540 | }, |
| 541 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/secrets": { |
| 542 | "get": { |
| 543 | "tags": [ |
| 544 | "Workspace installs" |
| 545 | ], |
| 546 | "summary": "List app secrets", |
| 547 | "operationId": "listWorkspaceAppSecrets", |
| 548 | "security": [ |
| 549 | { |
| 550 | "bearerAuth": [] |
| 551 | } |
| 552 | ], |
| 553 | "parameters": [ |
| 554 | { |
| 555 | "name": "workspaceSlug", |
| 556 | "in": "path", |
| 557 | "required": true, |
| 558 | "schema": { |
| 559 | "type": "string" |
| 560 | } |
| 561 | }, |
| 562 | { |
| 563 | "name": "appKey", |
| 564 | "in": "path", |
| 565 | "required": true, |
| 566 | "schema": { |
| 567 | "type": "string" |
| 568 | } |
| 569 | } |
| 570 | ], |
| 571 | "responses": { |
| 572 | "200": { |
| 573 | "description": "App secrets", |
| 574 | "content": { |
| 575 | "application/json": { |
| 576 | "schema": { |
| 577 | "$ref": "#/components/schemas/WorkspaceAppSecretsResponse" |
| 578 | } |
| 579 | } |
| 580 | } |
| 581 | } |
| 582 | } |
| 583 | }, |
| 584 | "post": { |
| 585 | "tags": [ |
| 586 | "Workspace installs" |
| 587 | ], |
| 588 | "summary": "Create or rotate app secret", |
| 589 | "operationId": "createWorkspaceAppSecret", |
| 590 | "security": [ |
| 591 | { |
| 592 | "bearerAuth": [] |
| 593 | } |
| 594 | ], |
| 595 | "parameters": [ |
| 596 | { |
| 597 | "name": "workspaceSlug", |
| 598 | "in": "path", |
| 599 | "required": true, |
| 600 | "schema": { |
| 601 | "type": "string" |
| 602 | } |
| 603 | }, |
| 604 | { |
| 605 | "name": "appKey", |
| 606 | "in": "path", |
| 607 | "required": true, |
| 608 | "schema": { |
| 609 | "type": "string" |
| 610 | } |
| 611 | } |
| 612 | ], |
| 613 | "requestBody": { |
| 614 | "required": true, |
| 615 | "content": { |
| 616 | "application/json": { |
| 617 | "schema": { |
| 618 | "type": "object", |
| 619 | "required": [ |
| 620 | "key", |
| 621 | "value" |
| 622 | ], |
| 623 | "properties": { |
| 624 | "key": { |
| 625 | "type": "string" |
| 626 | }, |
| 627 | "value": { |
| 628 | "type": "string" |
| 629 | } |
| 630 | } |
| 631 | } |
| 632 | } |
| 633 | } |
| 634 | }, |
| 635 | "responses": { |
| 636 | "201": { |
| 637 | "description": "App secret stored", |
| 638 | "content": { |
| 639 | "application/json": { |
| 640 | "schema": { |
| 641 | "$ref": "#/components/schemas/CreateWorkspaceAppSecretResponse" |
| 642 | } |
| 643 | } |
| 644 | } |
| 645 | } |
| 646 | } |
| 647 | } |
| 648 | }, |
| 649 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/secrets/{secretId}": { |
| 650 | "delete": { |
| 651 | "tags": [ |
| 652 | "Workspace installs" |
| 653 | ], |
| 654 | "summary": "Delete app secret", |
| 655 | "operationId": "deleteWorkspaceAppSecret", |
| 656 | "security": [ |
| 657 | { |
| 658 | "bearerAuth": [] |
| 659 | } |
| 660 | ], |
| 661 | "parameters": [ |
| 662 | { |
| 663 | "name": "workspaceSlug", |
| 664 | "in": "path", |
| 665 | "required": true, |
| 666 | "schema": { |
| 667 | "type": "string" |
| 668 | } |
| 669 | }, |
| 670 | { |
| 671 | "name": "appKey", |
| 672 | "in": "path", |
| 673 | "required": true, |
| 674 | "schema": { |
| 675 | "type": "string" |
| 676 | } |
| 677 | }, |
| 678 | { |
| 679 | "name": "secretId", |
| 680 | "in": "path", |
| 681 | "required": true, |
| 682 | "schema": { |
| 683 | "type": "string" |
| 684 | } |
| 685 | } |
| 686 | ], |
| 687 | "responses": { |
| 688 | "200": { |
| 689 | "description": "App secret deleted", |
| 690 | "content": { |
| 691 | "application/json": { |
| 692 | "schema": { |
| 693 | "$ref": "#/components/schemas/OkResponse" |
| 694 | } |
| 695 | } |
| 696 | } |
| 697 | } |
| 698 | } |
| 699 | } |
| 700 | }, |
| 701 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/oauth-connections": { |
| 702 | "get": { |
| 703 | "tags": [ |
| 704 | "Workspace installs" |
| 705 | ], |
| 706 | "summary": "List app OAuth connections", |
| 707 | "operationId": "listWorkspaceAppOauthConnections", |
| 708 | "security": [ |
| 709 | { |
| 710 | "bearerAuth": [] |
| 711 | } |
| 712 | ], |
| 713 | "parameters": [ |
| 714 | { |
| 715 | "name": "workspaceSlug", |
| 716 | "in": "path", |
| 717 | "required": true, |
| 718 | "schema": { |
| 719 | "type": "string" |
| 720 | } |
| 721 | }, |
| 722 | { |
| 723 | "name": "appKey", |
| 724 | "in": "path", |
| 725 | "required": true, |
| 726 | "schema": { |
| 727 | "type": "string" |
| 728 | } |
| 729 | } |
| 730 | ], |
| 731 | "responses": { |
| 732 | "200": { |
| 733 | "description": "App OAuth connections", |
| 734 | "content": { |
| 735 | "application/json": { |
| 736 | "schema": { |
| 737 | "$ref": "#/components/schemas/WorkspaceAppOauthConnectionsResponse" |
| 738 | } |
| 739 | } |
| 740 | } |
| 741 | } |
| 742 | } |
| 743 | }, |
| 744 | "post": { |
| 745 | "tags": [ |
| 746 | "Workspace installs" |
| 747 | ], |
| 748 | "summary": "Create or update app OAuth connection", |
| 749 | "operationId": "createWorkspaceAppOauthConnection", |
| 750 | "security": [ |
| 751 | { |
| 752 | "bearerAuth": [] |
| 753 | } |
| 754 | ], |
| 755 | "parameters": [ |
| 756 | { |
| 757 | "name": "workspaceSlug", |
| 758 | "in": "path", |
| 759 | "required": true, |
| 760 | "schema": { |
| 761 | "type": "string" |
| 762 | } |
| 763 | }, |
| 764 | { |
| 765 | "name": "appKey", |
| 766 | "in": "path", |
| 767 | "required": true, |
| 768 | "schema": { |
| 769 | "type": "string" |
| 770 | } |
| 771 | } |
| 772 | ], |
| 773 | "requestBody": { |
| 774 | "required": true, |
| 775 | "content": { |
| 776 | "application/json": { |
| 777 | "schema": { |
| 778 | "type": "object", |
| 779 | "required": [ |
| 780 | "providerKey", |
| 781 | "accessToken", |
| 782 | "scopes" |
| 783 | ], |
| 784 | "properties": { |
| 785 | "providerKey": { |
| 786 | "type": "string" |
| 787 | }, |
| 788 | "externalAccountId": { |
| 789 | "type": "string" |
| 790 | }, |
| 791 | "accessToken": { |
| 792 | "type": "string" |
| 793 | }, |
| 794 | "refreshToken": { |
| 795 | "type": "string" |
| 796 | }, |
| 797 | "scopes": { |
| 798 | "type": "array", |
| 799 | "items": { |
| 800 | "type": "string" |
| 801 | } |
| 802 | }, |
| 803 | "tokenExpiresAt": { |
| 804 | "type": "string", |
| 805 | "format": "date-time" |
| 806 | }, |
| 807 | "metadata": { |
| 808 | "type": "object", |
| 809 | "additionalProperties": true |
| 810 | } |
| 811 | } |
| 812 | } |
| 813 | } |
| 814 | } |
| 815 | }, |
| 816 | "responses": { |
| 817 | "201": { |
| 818 | "description": "App OAuth connection stored", |
| 819 | "content": { |
| 820 | "application/json": { |
| 821 | "schema": { |
| 822 | "$ref": "#/components/schemas/CreateWorkspaceAppOauthConnectionResponse" |
| 823 | } |
| 824 | } |
| 825 | } |
| 826 | } |
| 827 | } |
| 828 | } |
| 829 | }, |
| 830 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/oauth-connections/{connectionId}": { |
| 831 | "delete": { |
| 832 | "tags": [ |
| 833 | "Workspace installs" |
| 834 | ], |
| 835 | "summary": "Delete app OAuth connection", |
| 836 | "operationId": "deleteWorkspaceAppOauthConnection", |
| 837 | "security": [ |
| 838 | { |
| 839 | "bearerAuth": [] |
| 840 | } |
| 841 | ], |
| 842 | "parameters": [ |
| 843 | { |
| 844 | "name": "workspaceSlug", |
| 845 | "in": "path", |
| 846 | "required": true, |
| 847 | "schema": { |
| 848 | "type": "string" |
| 849 | } |
| 850 | }, |
| 851 | { |
| 852 | "name": "appKey", |
| 853 | "in": "path", |
| 854 | "required": true, |
| 855 | "schema": { |
| 856 | "type": "string" |
| 857 | } |
| 858 | }, |
| 859 | { |
| 860 | "name": "connectionId", |
| 861 | "in": "path", |
| 862 | "required": true, |
| 863 | "schema": { |
| 864 | "type": "string" |
| 865 | } |
| 866 | } |
| 867 | ], |
| 868 | "responses": { |
| 869 | "200": { |
| 870 | "description": "App OAuth connection deleted", |
| 871 | "content": { |
| 872 | "application/json": { |
| 873 | "schema": { |
| 874 | "$ref": "#/components/schemas/OkResponse" |
| 875 | } |
| 876 | } |
| 877 | } |
| 878 | } |
| 879 | } |
| 880 | } |
| 881 | }, |
| 882 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/deliveries": { |
| 883 | "get": { |
| 884 | "tags": [ |
| 885 | "Workspace installs" |
| 886 | ], |
| 887 | "summary": "List app deliveries", |
| 888 | "operationId": "listWorkspaceAppDeliveries", |
| 889 | "security": [ |
| 890 | { |
| 891 | "bearerAuth": [] |
| 892 | } |
| 893 | ], |
| 894 | "parameters": [ |
| 895 | { |
| 896 | "name": "workspaceSlug", |
| 897 | "in": "path", |
| 898 | "required": true, |
| 899 | "schema": { |
| 900 | "type": "string" |
| 901 | } |
| 902 | }, |
| 903 | { |
| 904 | "name": "appKey", |
| 905 | "in": "path", |
| 906 | "required": true, |
| 907 | "schema": { |
| 908 | "type": "string" |
| 909 | } |
| 910 | } |
| 911 | ], |
| 912 | "responses": { |
| 913 | "200": { |
| 914 | "description": "App deliveries", |
| 915 | "content": { |
| 916 | "application/json": { |
| 917 | "schema": { |
| 918 | "$ref": "#/components/schemas/WorkspaceAppDeliveriesResponse" |
| 919 | } |
| 920 | } |
| 921 | } |
| 922 | } |
| 923 | } |
| 924 | }, |
| 925 | "post": { |
| 926 | "tags": [ |
| 927 | "Workspace installs" |
| 928 | ], |
| 929 | "summary": "Send a signed test delivery", |
| 930 | "operationId": "sendWorkspaceAppTestDelivery", |
| 931 | "security": [ |
| 932 | { |
| 933 | "bearerAuth": [] |
| 934 | } |
| 935 | ], |
| 936 | "parameters": [ |
| 937 | { |
| 938 | "name": "workspaceSlug", |
| 939 | "in": "path", |
| 940 | "required": true, |
| 941 | "schema": { |
| 942 | "type": "string" |
| 943 | } |
| 944 | }, |
| 945 | { |
| 946 | "name": "appKey", |
| 947 | "in": "path", |
| 948 | "required": true, |
| 949 | "schema": { |
| 950 | "type": "string" |
| 951 | } |
| 952 | } |
| 953 | ], |
| 954 | "requestBody": { |
| 955 | "required": true, |
| 956 | "content": { |
| 957 | "application/json": { |
| 958 | "schema": { |
| 959 | "type": "object", |
| 960 | "required": [ |
| 961 | "eventType", |
| 962 | "payload" |
| 963 | ], |
| 964 | "properties": { |
| 965 | "eventType": { |
| 966 | "type": "string" |
| 967 | }, |
| 968 | "targetUrl": { |
| 969 | "type": "string" |
| 970 | }, |
| 971 | "payload": { |
| 972 | "type": "object", |
| 973 | "additionalProperties": true |
| 974 | } |
| 975 | } |
| 976 | } |
| 977 | } |
| 978 | } |
| 979 | }, |
| 980 | "responses": { |
| 981 | "201": { |
| 982 | "description": "Test delivery recorded", |
| 983 | "content": { |
| 984 | "application/json": { |
| 985 | "schema": { |
| 986 | "$ref": "#/components/schemas/SendWorkspaceAppTestDeliveryResponse" |
| 987 | } |
| 988 | } |
| 989 | } |
| 990 | } |
| 991 | } |
| 992 | } |
| 993 | }, |
| 994 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/deliveries/{deliveryId}/replay": { |
| 995 | "post": { |
| 996 | "tags": [ |
| 997 | "Workspace installs" |
| 998 | ], |
| 999 | "summary": "Replay a stored app delivery", |
| 1000 | "operationId": "replayWorkspaceAppDelivery", |
| 1001 | "security": [ |
| 1002 | { |
| 1003 | "bearerAuth": [] |
| 1004 | } |
| 1005 | ], |
| 1006 | "parameters": [ |
| 1007 | { |
| 1008 | "name": "workspaceSlug", |
| 1009 | "in": "path", |
| 1010 | "required": true, |
| 1011 | "schema": { |
| 1012 | "type": "string" |
| 1013 | } |
| 1014 | }, |
| 1015 | { |
| 1016 | "name": "appKey", |
| 1017 | "in": "path", |
| 1018 | "required": true, |
| 1019 | "schema": { |
| 1020 | "type": "string" |
| 1021 | } |
| 1022 | }, |
| 1023 | { |
| 1024 | "name": "deliveryId", |
| 1025 | "in": "path", |
| 1026 | "required": true, |
| 1027 | "schema": { |
| 1028 | "type": "string" |
| 1029 | } |
| 1030 | } |
| 1031 | ], |
| 1032 | "responses": { |
| 1033 | "200": { |
| 1034 | "description": "Delivery replayed", |
| 1035 | "content": { |
| 1036 | "application/json": { |
| 1037 | "schema": { |
| 1038 | "$ref": "#/components/schemas/SendWorkspaceAppTestDeliveryResponse" |
| 1039 | } |
| 1040 | } |
| 1041 | } |
| 1042 | } |
| 1043 | } |
| 1044 | } |
| 1045 | }, |
| 1046 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/files/{fileId}": { |
| 1047 | "get": { |
| 1048 | "tags": [ |
| 1049 | "Runtime" |
| 1050 | ], |
| 1051 | "summary": "Read an app-backed file document", |
| 1052 | "operationId": "getAppFileDocument", |
| 1053 | "security": [ |
| 1054 | { |
| 1055 | "bearerAuth": [] |
| 1056 | } |
| 1057 | ], |
| 1058 | "parameters": [ |
| 1059 | { |
| 1060 | "name": "workspaceSlug", |
| 1061 | "in": "path", |
| 1062 | "required": true, |
| 1063 | "schema": { |
| 1064 | "type": "string" |
| 1065 | } |
| 1066 | }, |
| 1067 | { |
| 1068 | "name": "appKey", |
| 1069 | "in": "path", |
| 1070 | "required": true, |
| 1071 | "schema": { |
| 1072 | "type": "string" |
| 1073 | } |
| 1074 | }, |
| 1075 | { |
| 1076 | "name": "fileId", |
| 1077 | "in": "path", |
| 1078 | "required": true, |
| 1079 | "schema": { |
| 1080 | "type": "string" |
| 1081 | } |
| 1082 | } |
| 1083 | ], |
| 1084 | "responses": { |
| 1085 | "200": { |
| 1086 | "description": "App-backed file document", |
| 1087 | "content": { |
| 1088 | "application/json": { |
| 1089 | "schema": { |
| 1090 | "$ref": "#/components/schemas/AppFileDocumentResponse" |
| 1091 | } |
| 1092 | } |
| 1093 | } |
| 1094 | } |
| 1095 | } |
| 1096 | }, |
| 1097 | "patch": { |
| 1098 | "tags": [ |
| 1099 | "Runtime" |
| 1100 | ], |
| 1101 | "summary": "Update an app-backed file document", |
| 1102 | "operationId": "updateAppFileDocument", |
| 1103 | "security": [ |
| 1104 | { |
| 1105 | "bearerAuth": [] |
| 1106 | } |
| 1107 | ], |
| 1108 | "parameters": [ |
| 1109 | { |
| 1110 | "name": "workspaceSlug", |
| 1111 | "in": "path", |
| 1112 | "required": true, |
| 1113 | "schema": { |
| 1114 | "type": "string" |
| 1115 | } |
| 1116 | }, |
| 1117 | { |
| 1118 | "name": "appKey", |
| 1119 | "in": "path", |
| 1120 | "required": true, |
| 1121 | "schema": { |
| 1122 | "type": "string" |
| 1123 | } |
| 1124 | }, |
| 1125 | { |
| 1126 | "name": "fileId", |
| 1127 | "in": "path", |
| 1128 | "required": true, |
| 1129 | "schema": { |
| 1130 | "type": "string" |
| 1131 | } |
| 1132 | } |
| 1133 | ], |
| 1134 | "requestBody": { |
| 1135 | "required": true, |
| 1136 | "content": { |
| 1137 | "application/json": { |
| 1138 | "schema": { |
| 1139 | "type": "object", |
| 1140 | "required": [ |
| 1141 | "document" |
| 1142 | ], |
| 1143 | "properties": { |
| 1144 | "document": { |
| 1145 | "type": "object", |
| 1146 | "additionalProperties": true |
| 1147 | } |
| 1148 | } |
| 1149 | } |
| 1150 | } |
| 1151 | } |
| 1152 | }, |
| 1153 | "responses": { |
| 1154 | "200": { |
| 1155 | "description": "Updated app-backed file document", |
| 1156 | "content": { |
| 1157 | "application/json": { |
| 1158 | "schema": { |
| 1159 | "$ref": "#/components/schemas/AppFileDocumentUpdateResponse" |
| 1160 | } |
| 1161 | } |
| 1162 | } |
| 1163 | } |
| 1164 | } |
| 1165 | } |
| 1166 | }, |
| 1167 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/notifications": { |
| 1168 | "post": { |
| 1169 | "tags": [ |
| 1170 | "Runtime" |
| 1171 | ], |
| 1172 | "summary": "Create an app notification", |
| 1173 | "operationId": "createAppNotification", |
| 1174 | "security": [ |
| 1175 | { |
| 1176 | "bearerAuth": [] |
| 1177 | } |
| 1178 | ], |
| 1179 | "parameters": [ |
| 1180 | { |
| 1181 | "name": "workspaceSlug", |
| 1182 | "in": "path", |
| 1183 | "required": true, |
| 1184 | "schema": { |
| 1185 | "type": "string" |
| 1186 | } |
| 1187 | }, |
| 1188 | { |
| 1189 | "name": "appKey", |
| 1190 | "in": "path", |
| 1191 | "required": true, |
| 1192 | "schema": { |
| 1193 | "type": "string" |
| 1194 | } |
| 1195 | } |
| 1196 | ], |
| 1197 | "requestBody": { |
| 1198 | "required": true, |
| 1199 | "content": { |
| 1200 | "application/json": { |
| 1201 | "schema": { |
| 1202 | "$ref": "#/components/schemas/CreateAppNotificationInput" |
| 1203 | } |
| 1204 | } |
| 1205 | } |
| 1206 | }, |
| 1207 | "responses": { |
| 1208 | "201": { |
| 1209 | "description": "Notification created", |
| 1210 | "content": { |
| 1211 | "application/json": { |
| 1212 | "schema": { |
| 1213 | "$ref": "#/components/schemas/OkResponse" |
| 1214 | } |
| 1215 | } |
| 1216 | } |
| 1217 | } |
| 1218 | } |
| 1219 | } |
| 1220 | }, |
| 1221 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/index-documents": { |
| 1222 | "post": { |
| 1223 | "tags": [ |
| 1224 | "Runtime" |
| 1225 | ], |
| 1226 | "summary": "Upsert app index documents", |
| 1227 | "operationId": "upsertAppIndexDocuments", |
| 1228 | "security": [ |
| 1229 | { |
| 1230 | "bearerAuth": [] |
| 1231 | } |
| 1232 | ], |
| 1233 | "parameters": [ |
| 1234 | { |
| 1235 | "name": "workspaceSlug", |
| 1236 | "in": "path", |
| 1237 | "required": true, |
| 1238 | "schema": { |
| 1239 | "type": "string" |
| 1240 | } |
| 1241 | }, |
| 1242 | { |
| 1243 | "name": "appKey", |
| 1244 | "in": "path", |
| 1245 | "required": true, |
| 1246 | "schema": { |
| 1247 | "type": "string" |
| 1248 | } |
| 1249 | } |
| 1250 | ], |
| 1251 | "requestBody": { |
| 1252 | "required": true, |
| 1253 | "content": { |
| 1254 | "application/json": { |
| 1255 | "schema": { |
| 1256 | "$ref": "#/components/schemas/UpsertAppIndexDocumentsInput" |
| 1257 | } |
| 1258 | } |
| 1259 | } |
| 1260 | }, |
| 1261 | "responses": { |
| 1262 | "201": { |
| 1263 | "description": "Index documents upserted", |
| 1264 | "content": { |
| 1265 | "application/json": { |
| 1266 | "schema": { |
| 1267 | "$ref": "#/components/schemas/UpsertAppIndexDocumentsResponse" |
| 1268 | } |
| 1269 | } |
| 1270 | } |
| 1271 | } |
| 1272 | } |
| 1273 | }, |
| 1274 | "delete": { |
| 1275 | "tags": [ |
| 1276 | "Runtime" |
| 1277 | ], |
| 1278 | "summary": "Delete app index documents", |
| 1279 | "operationId": "deleteAppIndexDocuments", |
| 1280 | "security": [ |
| 1281 | { |
| 1282 | "bearerAuth": [] |
| 1283 | } |
| 1284 | ], |
| 1285 | "parameters": [ |
| 1286 | { |
| 1287 | "name": "workspaceSlug", |
| 1288 | "in": "path", |
| 1289 | "required": true, |
| 1290 | "schema": { |
| 1291 | "type": "string" |
| 1292 | } |
| 1293 | }, |
| 1294 | { |
| 1295 | "name": "appKey", |
| 1296 | "in": "path", |
| 1297 | "required": true, |
| 1298 | "schema": { |
| 1299 | "type": "string" |
| 1300 | } |
| 1301 | } |
| 1302 | ], |
| 1303 | "requestBody": { |
| 1304 | "required": true, |
| 1305 | "content": { |
| 1306 | "application/json": { |
| 1307 | "schema": { |
| 1308 | "$ref": "#/components/schemas/DeleteAppIndexDocumentsInput" |
| 1309 | } |
| 1310 | } |
| 1311 | } |
| 1312 | }, |
| 1313 | "responses": { |
| 1314 | "200": { |
| 1315 | "description": "Index documents deleted", |
| 1316 | "content": { |
| 1317 | "application/json": { |
| 1318 | "schema": { |
| 1319 | "$ref": "#/components/schemas/DeleteAppIndexDocumentsResponse" |
| 1320 | } |
| 1321 | } |
| 1322 | } |
| 1323 | } |
| 1324 | } |
| 1325 | } |
| 1326 | }, |
| 1327 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/ambient/events": { |
| 1328 | "post": { |
| 1329 | "tags": [ |
| 1330 | "Runtime" |
| 1331 | ], |
| 1332 | "summary": "Emit app ambient events", |
| 1333 | "operationId": "emitAppAmbientEvents", |
| 1334 | "security": [ |
| 1335 | { |
| 1336 | "bearerAuth": [] |
| 1337 | } |
| 1338 | ], |
| 1339 | "parameters": [ |
| 1340 | { |
| 1341 | "name": "workspaceSlug", |
| 1342 | "in": "path", |
| 1343 | "required": true, |
| 1344 | "schema": { |
| 1345 | "type": "string" |
| 1346 | } |
| 1347 | }, |
| 1348 | { |
| 1349 | "name": "appKey", |
| 1350 | "in": "path", |
| 1351 | "required": true, |
| 1352 | "schema": { |
| 1353 | "type": "string" |
| 1354 | } |
| 1355 | } |
| 1356 | ], |
| 1357 | "requestBody": { |
| 1358 | "required": true, |
| 1359 | "content": { |
| 1360 | "application/json": { |
| 1361 | "schema": { |
| 1362 | "$ref": "#/components/schemas/EmitAppAmbientEventsInput" |
| 1363 | } |
| 1364 | } |
| 1365 | } |
| 1366 | }, |
| 1367 | "responses": { |
| 1368 | "201": { |
| 1369 | "description": "Ambient events accepted", |
| 1370 | "content": { |
| 1371 | "application/json": { |
| 1372 | "schema": { |
| 1373 | "$ref": "#/components/schemas/EmitAppAmbientEventsResponse" |
| 1374 | } |
| 1375 | } |
| 1376 | } |
| 1377 | } |
| 1378 | } |
| 1379 | } |
| 1380 | } |
| 1381 | }, |
| 1382 | "components": { |
| 1383 | "securitySchemes": { |
| 1384 | "bearerAuth": { |
| 1385 | "type": "http", |
| 1386 | "scheme": "bearer", |
| 1387 | "bearerFormat": "API key or session-backed bearer token" |
| 1388 | } |
| 1389 | }, |
| 1390 | "schemas": { |
| 1391 | "ErrorEnvelope": { |
| 1392 | "type": "object", |
| 1393 | "required": [ |
| 1394 | "error" |
| 1395 | ], |
| 1396 | "properties": { |
| 1397 | "error": { |
| 1398 | "type": "object", |
| 1399 | "required": [ |
| 1400 | "code", |
| 1401 | "message" |
| 1402 | ], |
| 1403 | "properties": { |
| 1404 | "code": { |
| 1405 | "type": "string" |
| 1406 | }, |
| 1407 | "message": { |
| 1408 | "type": "string" |
| 1409 | } |
| 1410 | } |
| 1411 | } |
| 1412 | } |
| 1413 | }, |
| 1414 | "OkResponse": { |
| 1415 | "type": "object", |
| 1416 | "required": [ |
| 1417 | "data" |
| 1418 | ], |
| 1419 | "properties": { |
| 1420 | "data": { |
| 1421 | "type": "object", |
| 1422 | "required": [ |
| 1423 | "ok" |
| 1424 | ], |
| 1425 | "properties": { |
| 1426 | "ok": { |
| 1427 | "type": "boolean", |
| 1428 | "const": true |
| 1429 | } |
| 1430 | } |
| 1431 | } |
| 1432 | } |
| 1433 | }, |
| 1434 | "AppCatalogItem": { |
| 1435 | "type": "object", |
| 1436 | "required": [ |
| 1437 | "appId", |
| 1438 | "appKey", |
| 1439 | "name", |
| 1440 | "description", |
| 1441 | "iconUrl", |
| 1442 | "status", |
| 1443 | "latestPublishedVersion", |
| 1444 | "latestPublishedVersionId", |
| 1445 | "isInstalled" |
| 1446 | ], |
| 1447 | "properties": { |
| 1448 | "appId": { |
| 1449 | "type": "string" |
| 1450 | }, |
| 1451 | "appKey": { |
| 1452 | "type": "string" |
| 1453 | }, |
| 1454 | "name": { |
| 1455 | "type": "string" |
| 1456 | }, |
| 1457 | "description": { |
| 1458 | "type": [ |
| 1459 | "string", |
| 1460 | "null" |
| 1461 | ] |
| 1462 | }, |
| 1463 | "iconUrl": { |
| 1464 | "type": [ |
| 1465 | "string", |
| 1466 | "null" |
| 1467 | ] |
| 1468 | }, |
| 1469 | "status": { |
| 1470 | "type": "string" |
| 1471 | }, |
| 1472 | "latestPublishedVersion": { |
| 1473 | "type": [ |
| 1474 | "string", |
| 1475 | "null" |
| 1476 | ] |
| 1477 | }, |
| 1478 | "latestPublishedVersionId": { |
| 1479 | "type": [ |
| 1480 | "string", |
| 1481 | "null" |
| 1482 | ] |
| 1483 | }, |
| 1484 | "isInstalled": { |
| 1485 | "type": "boolean" |
| 1486 | } |
| 1487 | } |
| 1488 | }, |
| 1489 | "RegisteredAppDetail": { |
| 1490 | "type": "object", |
| 1491 | "required": [ |
| 1492 | "appId", |
| 1493 | "appKey", |
| 1494 | "name", |
| 1495 | "description", |
| 1496 | "iconUrl", |
| 1497 | "status", |
| 1498 | "ownerUserId", |
| 1499 | "storeListed", |
| 1500 | "latestPublishedVersion", |
| 1501 | "latestPublishedVersionId" |
| 1502 | ], |
| 1503 | "properties": { |
| 1504 | "appId": { |
| 1505 | "type": "string" |
| 1506 | }, |
| 1507 | "appKey": { |
| 1508 | "type": "string" |
| 1509 | }, |
| 1510 | "name": { |
| 1511 | "type": "string" |
| 1512 | }, |
| 1513 | "description": { |
| 1514 | "type": [ |
| 1515 | "string", |
| 1516 | "null" |
| 1517 | ] |
| 1518 | }, |
| 1519 | "iconUrl": { |
| 1520 | "type": [ |
| 1521 | "string", |
| 1522 | "null" |
| 1523 | ] |
| 1524 | }, |
| 1525 | "status": { |
| 1526 | "type": "string" |
| 1527 | }, |
| 1528 | "ownerUserId": { |
| 1529 | "type": [ |
| 1530 | "string", |
| 1531 | "null" |
| 1532 | ] |
| 1533 | }, |
| 1534 | "storeListed": { |
| 1535 | "type": "boolean" |
| 1536 | }, |
| 1537 | "latestPublishedVersion": { |
| 1538 | "type": [ |
| 1539 | "string", |
| 1540 | "null" |
| 1541 | ] |
| 1542 | }, |
| 1543 | "latestPublishedVersionId": { |
| 1544 | "type": [ |
| 1545 | "string", |
| 1546 | "null" |
| 1547 | ] |
| 1548 | } |
| 1549 | } |
| 1550 | }, |
| 1551 | "RegisteredAppVersionSummary": { |
| 1552 | "type": "object", |
| 1553 | "required": [ |
| 1554 | "versionId", |
| 1555 | "version", |
| 1556 | "status", |
| 1557 | "reviewStatus", |
| 1558 | "apiBaseUrl", |
| 1559 | "permissions", |
| 1560 | "notificationChannels", |
| 1561 | "kairo", |
| 1562 | "fileTypes", |
| 1563 | "submittedAt", |
| 1564 | "reviewedAt", |
| 1565 | "reviewNotes", |
| 1566 | "publishedAt", |
| 1567 | "createdAt", |
| 1568 | "updatedAt" |
| 1569 | ], |
| 1570 | "properties": { |
| 1571 | "versionId": { |
| 1572 | "type": "string" |
| 1573 | }, |
| 1574 | "version": { |
| 1575 | "type": "string" |
| 1576 | }, |
| 1577 | "status": { |
| 1578 | "type": "string" |
| 1579 | }, |
| 1580 | "reviewStatus": { |
| 1581 | "type": "string" |
| 1582 | }, |
| 1583 | "apiBaseUrl": { |
| 1584 | "type": "string" |
| 1585 | }, |
| 1586 | "permissions": { |
| 1587 | "type": "array", |
| 1588 | "items": { |
| 1589 | "type": "string" |
| 1590 | } |
| 1591 | }, |
| 1592 | "notificationChannels": { |
| 1593 | "type": "array", |
| 1594 | "items": { |
| 1595 | "type": "object", |
| 1596 | "required": [ |
| 1597 | "key", |
| 1598 | "name", |
| 1599 | "defaultDeliveries", |
| 1600 | "defaultPriority" |
| 1601 | ], |
| 1602 | "properties": { |
| 1603 | "key": { |
| 1604 | "type": "string" |
| 1605 | }, |
| 1606 | "name": { |
| 1607 | "type": "string" |
| 1608 | }, |
| 1609 | "description": { |
| 1610 | "type": "string" |
| 1611 | }, |
| 1612 | "defaultDeliveries": { |
| 1613 | "type": "array", |
| 1614 | "items": { |
| 1615 | "type": "string" |
| 1616 | } |
| 1617 | }, |
| 1618 | "defaultPriority": { |
| 1619 | "type": "string" |
| 1620 | } |
| 1621 | } |
| 1622 | } |
| 1623 | }, |
| 1624 | "kairo": { |
| 1625 | "oneOf": [ |
| 1626 | { |
| 1627 | "type": "object", |
| 1628 | "additionalProperties": true |
| 1629 | }, |
| 1630 | { |
| 1631 | "type": "null" |
| 1632 | } |
| 1633 | ] |
| 1634 | }, |
| 1635 | "fileTypes": { |
| 1636 | "type": "array", |
| 1637 | "items": { |
| 1638 | "type": "object", |
| 1639 | "required": [ |
| 1640 | "typeKey", |
| 1641 | "name", |
| 1642 | "description" |
| 1643 | ], |
| 1644 | "properties": { |
| 1645 | "typeKey": { |
| 1646 | "type": "string" |
| 1647 | }, |
| 1648 | "name": { |
| 1649 | "type": "string" |
| 1650 | }, |
| 1651 | "description": { |
| 1652 | "type": [ |
| 1653 | "string", |
| 1654 | "null" |
| 1655 | ] |
| 1656 | } |
| 1657 | } |
| 1658 | } |
| 1659 | }, |
| 1660 | "submittedAt": { |
| 1661 | "type": [ |
| 1662 | "string", |
| 1663 | "null" |
| 1664 | ], |
| 1665 | "format": "date-time" |
| 1666 | }, |
| 1667 | "reviewedAt": { |
| 1668 | "type": [ |
| 1669 | "string", |
| 1670 | "null" |
| 1671 | ], |
| 1672 | "format": "date-time" |
| 1673 | }, |
| 1674 | "reviewNotes": { |
| 1675 | "type": [ |
| 1676 | "string", |
| 1677 | "null" |
| 1678 | ] |
| 1679 | }, |
| 1680 | "publishedAt": { |
| 1681 | "type": [ |
| 1682 | "string", |
| 1683 | "null" |
| 1684 | ], |
| 1685 | "format": "date-time" |
| 1686 | }, |
| 1687 | "createdAt": { |
| 1688 | "type": "string", |
| 1689 | "format": "date-time" |
| 1690 | }, |
| 1691 | "updatedAt": { |
| 1692 | "type": "string", |
| 1693 | "format": "date-time" |
| 1694 | } |
| 1695 | } |
| 1696 | }, |
| 1697 | "InstalledAppSummary": { |
| 1698 | "type": "object", |
| 1699 | "required": [ |
| 1700 | "installId", |
| 1701 | "appId", |
| 1702 | "appKey", |
| 1703 | "name", |
| 1704 | "description", |
| 1705 | "iconUrl", |
| 1706 | "status", |
| 1707 | "installScope", |
| 1708 | "scopeSubjectId", |
| 1709 | "version" |
| 1710 | ], |
| 1711 | "properties": { |
| 1712 | "installId": { |
| 1713 | "type": "string" |
| 1714 | }, |
| 1715 | "appId": { |
| 1716 | "type": "string" |
| 1717 | }, |
| 1718 | "appKey": { |
| 1719 | "type": "string" |
| 1720 | }, |
| 1721 | "name": { |
| 1722 | "type": "string" |
| 1723 | }, |
| 1724 | "description": { |
| 1725 | "type": [ |
| 1726 | "string", |
| 1727 | "null" |
| 1728 | ] |
| 1729 | }, |
| 1730 | "iconUrl": { |
| 1731 | "type": [ |
| 1732 | "string", |
| 1733 | "null" |
| 1734 | ] |
| 1735 | }, |
| 1736 | "status": { |
| 1737 | "type": "string" |
| 1738 | }, |
| 1739 | "installScope": { |
| 1740 | "type": "string" |
| 1741 | }, |
| 1742 | "scopeSubjectId": { |
| 1743 | "type": "string" |
| 1744 | }, |
| 1745 | "version": { |
| 1746 | "type": [ |
| 1747 | "string", |
| 1748 | "null" |
| 1749 | ] |
| 1750 | } |
| 1751 | } |
| 1752 | }, |
| 1753 | "StoreAppsResponse": { |
| 1754 | "type": "object", |
| 1755 | "required": [ |
| 1756 | "data" |
| 1757 | ], |
| 1758 | "properties": { |
| 1759 | "data": { |
| 1760 | "type": "object", |
| 1761 | "required": [ |
| 1762 | "apps" |
| 1763 | ], |
| 1764 | "properties": { |
| 1765 | "apps": { |
| 1766 | "type": "array", |
| 1767 | "items": { |
| 1768 | "$ref": "#/components/schemas/RegisteredAppDetail" |
| 1769 | } |
| 1770 | } |
| 1771 | } |
| 1772 | } |
| 1773 | } |
| 1774 | }, |
| 1775 | "StoreAppResponse": { |
| 1776 | "type": "object", |
| 1777 | "required": [ |
| 1778 | "data" |
| 1779 | ], |
| 1780 | "properties": { |
| 1781 | "data": { |
| 1782 | "type": "object", |
| 1783 | "required": [ |
| 1784 | "app" |
| 1785 | ], |
| 1786 | "properties": { |
| 1787 | "app": { |
| 1788 | "$ref": "#/components/schemas/RegisteredAppDetail" |
| 1789 | } |
| 1790 | } |
| 1791 | } |
| 1792 | } |
| 1793 | }, |
| 1794 | "StoreAppVersionsResponse": { |
| 1795 | "type": "object", |
| 1796 | "required": [ |
| 1797 | "data" |
| 1798 | ], |
| 1799 | "properties": { |
| 1800 | "data": { |
| 1801 | "type": "object", |
| 1802 | "required": [ |
| 1803 | "versions" |
| 1804 | ], |
| 1805 | "properties": { |
| 1806 | "versions": { |
| 1807 | "type": "array", |
| 1808 | "items": { |
| 1809 | "$ref": "#/components/schemas/RegisteredAppVersionSummary" |
| 1810 | } |
| 1811 | } |
| 1812 | } |
| 1813 | } |
| 1814 | } |
| 1815 | }, |
| 1816 | "WorkspaceAppsResponse": { |
| 1817 | "type": "object", |
| 1818 | "required": [ |
| 1819 | "data" |
| 1820 | ], |
| 1821 | "properties": { |
| 1822 | "data": { |
| 1823 | "type": "object", |
| 1824 | "required": [ |
| 1825 | "installedApps", |
| 1826 | "catalog", |
| 1827 | "permissions" |
| 1828 | ], |
| 1829 | "properties": { |
| 1830 | "installedApps": { |
| 1831 | "type": "array", |
| 1832 | "items": { |
| 1833 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 1834 | } |
| 1835 | }, |
| 1836 | "catalog": { |
| 1837 | "type": "array", |
| 1838 | "items": { |
| 1839 | "$ref": "#/components/schemas/AppCatalogItem" |
| 1840 | } |
| 1841 | }, |
| 1842 | "permissions": { |
| 1843 | "type": "object", |
| 1844 | "required": [ |
| 1845 | "canManageApps" |
| 1846 | ], |
| 1847 | "properties": { |
| 1848 | "canManageApps": { |
| 1849 | "type": "boolean" |
| 1850 | } |
| 1851 | } |
| 1852 | } |
| 1853 | } |
| 1854 | } |
| 1855 | } |
| 1856 | }, |
| 1857 | "InstallWorkspaceAppInput": { |
| 1858 | "type": "object", |
| 1859 | "required": [ |
| 1860 | "appId" |
| 1861 | ], |
| 1862 | "properties": { |
| 1863 | "appId": { |
| 1864 | "type": "string" |
| 1865 | }, |
| 1866 | "pinnedVersionId": { |
| 1867 | "type": "string" |
| 1868 | }, |
| 1869 | "grantedPermissions": { |
| 1870 | "type": "array", |
| 1871 | "items": { |
| 1872 | "type": "string" |
| 1873 | } |
| 1874 | } |
| 1875 | } |
| 1876 | }, |
| 1877 | "InstallWorkspaceAppResponse": { |
| 1878 | "type": "object", |
| 1879 | "required": [ |
| 1880 | "data" |
| 1881 | ], |
| 1882 | "properties": { |
| 1883 | "data": { |
| 1884 | "type": "object", |
| 1885 | "required": [ |
| 1886 | "installId", |
| 1887 | "appId", |
| 1888 | "appKey", |
| 1889 | "version", |
| 1890 | "grantedPermissions" |
| 1891 | ], |
| 1892 | "properties": { |
| 1893 | "installId": { |
| 1894 | "type": "string" |
| 1895 | }, |
| 1896 | "appId": { |
| 1897 | "type": "string" |
| 1898 | }, |
| 1899 | "appKey": { |
| 1900 | "type": "string" |
| 1901 | }, |
| 1902 | "version": { |
| 1903 | "type": "string" |
| 1904 | }, |
| 1905 | "grantedPermissions": { |
| 1906 | "type": "array", |
| 1907 | "items": { |
| 1908 | "type": "string" |
| 1909 | } |
| 1910 | } |
| 1911 | } |
| 1912 | } |
| 1913 | } |
| 1914 | }, |
| 1915 | "WorkspaceInstalledAppResponse": { |
| 1916 | "type": "object", |
| 1917 | "required": [ |
| 1918 | "data" |
| 1919 | ], |
| 1920 | "properties": { |
| 1921 | "data": { |
| 1922 | "type": "object", |
| 1923 | "required": [ |
| 1924 | "install", |
| 1925 | "permissions" |
| 1926 | ], |
| 1927 | "properties": { |
| 1928 | "install": { |
| 1929 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 1930 | }, |
| 1931 | "permissions": { |
| 1932 | "type": "object", |
| 1933 | "required": [ |
| 1934 | "canManageApps" |
| 1935 | ], |
| 1936 | "properties": { |
| 1937 | "canManageApps": { |
| 1938 | "type": "boolean" |
| 1939 | } |
| 1940 | } |
| 1941 | } |
| 1942 | } |
| 1943 | } |
| 1944 | } |
| 1945 | }, |
| 1946 | "WorkspaceAppPermissionsResponse": { |
| 1947 | "type": "object", |
| 1948 | "required": [ |
| 1949 | "data" |
| 1950 | ], |
| 1951 | "properties": { |
| 1952 | "data": { |
| 1953 | "type": "object", |
| 1954 | "required": [ |
| 1955 | "install", |
| 1956 | "availablePermissions", |
| 1957 | "grantedPermissions", |
| 1958 | "permissions" |
| 1959 | ], |
| 1960 | "properties": { |
| 1961 | "install": { |
| 1962 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 1963 | }, |
| 1964 | "availablePermissions": { |
| 1965 | "type": "array", |
| 1966 | "items": { |
| 1967 | "type": "string" |
| 1968 | } |
| 1969 | }, |
| 1970 | "grantedPermissions": { |
| 1971 | "type": "array", |
| 1972 | "items": { |
| 1973 | "type": "string" |
| 1974 | } |
| 1975 | }, |
| 1976 | "permissions": { |
| 1977 | "type": "object", |
| 1978 | "required": [ |
| 1979 | "canManageApps" |
| 1980 | ], |
| 1981 | "properties": { |
| 1982 | "canManageApps": { |
| 1983 | "type": "boolean" |
| 1984 | } |
| 1985 | } |
| 1986 | } |
| 1987 | } |
| 1988 | } |
| 1989 | } |
| 1990 | }, |
| 1991 | "RegisterAppInput": { |
| 1992 | "type": "object", |
| 1993 | "required": [ |
| 1994 | "version", |
| 1995 | "manifest", |
| 1996 | "fileTypes" |
| 1997 | ], |
| 1998 | "properties": { |
| 1999 | "version": { |
| 2000 | "type": "string" |
| 2001 | }, |
| 2002 | "manifest": { |
| 2003 | "type": "object", |
| 2004 | "required": [ |
| 2005 | "key", |
| 2006 | "name", |
| 2007 | "permissions", |
| 2008 | "notificationChannels", |
| 2009 | "hosting" |
| 2010 | ], |
| 2011 | "properties": { |
| 2012 | "key": { |
| 2013 | "type": "string" |
| 2014 | }, |
| 2015 | "name": { |
| 2016 | "type": "string" |
| 2017 | }, |
| 2018 | "description": { |
| 2019 | "type": "string" |
| 2020 | }, |
| 2021 | "iconUrl": { |
| 2022 | "type": "string" |
| 2023 | }, |
| 2024 | "permissions": { |
| 2025 | "type": "array", |
| 2026 | "items": { |
| 2027 | "type": "string" |
| 2028 | } |
| 2029 | }, |
| 2030 | "notificationChannels": { |
| 2031 | "type": "array", |
| 2032 | "items": { |
| 2033 | "type": "object", |
| 2034 | "required": [ |
| 2035 | "key", |
| 2036 | "name", |
| 2037 | "defaultDeliveries", |
| 2038 | "defaultPriority" |
| 2039 | ], |
| 2040 | "properties": { |
| 2041 | "key": { |
| 2042 | "type": "string" |
| 2043 | }, |
| 2044 | "name": { |
| 2045 | "type": "string" |
| 2046 | }, |
| 2047 | "description": { |
| 2048 | "type": "string" |
| 2049 | }, |
| 2050 | "defaultDeliveries": { |
| 2051 | "type": "array", |
| 2052 | "items": { |
| 2053 | "type": "string" |
| 2054 | } |
| 2055 | }, |
| 2056 | "defaultPriority": { |
| 2057 | "type": "string" |
| 2058 | } |
| 2059 | } |
| 2060 | } |
| 2061 | }, |
| 2062 | "kairo": { |
| 2063 | "type": "object", |
| 2064 | "additionalProperties": true |
| 2065 | }, |
| 2066 | "hosting": { |
| 2067 | "type": "object", |
| 2068 | "required": [ |
| 2069 | "mode", |
| 2070 | "baseUrl" |
| 2071 | ], |
| 2072 | "properties": { |
| 2073 | "mode": { |
| 2074 | "type": "string", |
| 2075 | "const": "external" |
| 2076 | }, |
| 2077 | "baseUrl": { |
| 2078 | "type": "string" |
| 2079 | } |
| 2080 | } |
| 2081 | } |
| 2082 | } |
| 2083 | }, |
| 2084 | "fileTypes": { |
| 2085 | "type": "array", |
| 2086 | "items": { |
| 2087 | "type": "object", |
| 2088 | "required": [ |
| 2089 | "typeKey", |
| 2090 | "name", |
| 2091 | "storage", |
| 2092 | "indexable", |
| 2093 | "homeRenderMode" |
| 2094 | ], |
| 2095 | "properties": { |
| 2096 | "typeKey": { |
| 2097 | "type": "string" |
| 2098 | }, |
| 2099 | "name": { |
| 2100 | "type": "string" |
| 2101 | }, |
| 2102 | "description": { |
| 2103 | "type": "string" |
| 2104 | }, |
| 2105 | "storage": { |
| 2106 | "type": "string", |
| 2107 | "const": "coline_document" |
| 2108 | }, |
| 2109 | "indexable": { |
| 2110 | "type": "boolean" |
| 2111 | }, |
| 2112 | "homeRenderMode": { |
| 2113 | "type": "string" |
| 2114 | } |
| 2115 | } |
| 2116 | } |
| 2117 | } |
| 2118 | } |
| 2119 | }, |
| 2120 | "AppVersionMutationResponse": { |
| 2121 | "type": "object", |
| 2122 | "required": [ |
| 2123 | "data" |
| 2124 | ], |
| 2125 | "properties": { |
| 2126 | "data": { |
| 2127 | "type": "object", |
| 2128 | "required": [ |
| 2129 | "appId", |
| 2130 | "appKey", |
| 2131 | "versionId", |
| 2132 | "version" |
| 2133 | ], |
| 2134 | "properties": { |
| 2135 | "appId": { |
| 2136 | "type": "string" |
| 2137 | }, |
| 2138 | "appKey": { |
| 2139 | "type": "string" |
| 2140 | }, |
| 2141 | "versionId": { |
| 2142 | "type": "string" |
| 2143 | }, |
| 2144 | "version": { |
| 2145 | "type": "string" |
| 2146 | } |
| 2147 | } |
| 2148 | } |
| 2149 | } |
| 2150 | }, |
| 2151 | "SubmitAppVersionForReviewResponse": { |
| 2152 | "type": "object", |
| 2153 | "required": [ |
| 2154 | "data" |
| 2155 | ], |
| 2156 | "properties": { |
| 2157 | "data": { |
| 2158 | "type": "object", |
| 2159 | "required": [ |
| 2160 | "appId", |
| 2161 | "appKey", |
| 2162 | "versionId", |
| 2163 | "version", |
| 2164 | "reviewStatus", |
| 2165 | "storeListed" |
| 2166 | ], |
| 2167 | "properties": { |
| 2168 | "appId": { |
| 2169 | "type": "string" |
| 2170 | }, |
| 2171 | "appKey": { |
| 2172 | "type": "string" |
| 2173 | }, |
| 2174 | "versionId": { |
| 2175 | "type": "string" |
| 2176 | }, |
| 2177 | "version": { |
| 2178 | "type": "string" |
| 2179 | }, |
| 2180 | "reviewStatus": { |
| 2181 | "type": "string", |
| 2182 | "const": "submitted" |
| 2183 | }, |
| 2184 | "storeListed": { |
| 2185 | "type": "boolean" |
| 2186 | } |
| 2187 | } |
| 2188 | } |
| 2189 | } |
| 2190 | }, |
| 2191 | "WorkspaceAppSecretsResponse": { |
| 2192 | "type": "object", |
| 2193 | "required": [ |
| 2194 | "data" |
| 2195 | ], |
| 2196 | "properties": { |
| 2197 | "data": { |
| 2198 | "type": "object", |
| 2199 | "required": [ |
| 2200 | "install", |
| 2201 | "secrets", |
| 2202 | "permissions" |
| 2203 | ], |
| 2204 | "properties": { |
| 2205 | "install": { |
| 2206 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 2207 | }, |
| 2208 | "secrets": { |
| 2209 | "type": "array", |
| 2210 | "items": { |
| 2211 | "type": "object", |
| 2212 | "required": [ |
| 2213 | "id", |
| 2214 | "key", |
| 2215 | "createdAt", |
| 2216 | "updatedAt" |
| 2217 | ], |
| 2218 | "properties": { |
| 2219 | "id": { |
| 2220 | "type": "string" |
| 2221 | }, |
| 2222 | "key": { |
| 2223 | "type": "string" |
| 2224 | }, |
| 2225 | "createdAt": { |
| 2226 | "type": "string", |
| 2227 | "format": "date-time" |
| 2228 | }, |
| 2229 | "updatedAt": { |
| 2230 | "type": "string", |
| 2231 | "format": "date-time" |
| 2232 | } |
| 2233 | } |
| 2234 | } |
| 2235 | }, |
| 2236 | "permissions": { |
| 2237 | "type": "object", |
| 2238 | "required": [ |
| 2239 | "canManageApps" |
| 2240 | ], |
| 2241 | "properties": { |
| 2242 | "canManageApps": { |
| 2243 | "type": "boolean" |
| 2244 | } |
| 2245 | } |
| 2246 | } |
| 2247 | } |
| 2248 | } |
| 2249 | } |
| 2250 | }, |
| 2251 | "CreateWorkspaceAppSecretResponse": { |
| 2252 | "type": "object", |
| 2253 | "required": [ |
| 2254 | "data" |
| 2255 | ], |
| 2256 | "properties": { |
| 2257 | "data": { |
| 2258 | "type": "object", |
| 2259 | "required": [ |
| 2260 | "secret", |
| 2261 | "value" |
| 2262 | ], |
| 2263 | "properties": { |
| 2264 | "secret": { |
| 2265 | "type": "object", |
| 2266 | "required": [ |
| 2267 | "id", |
| 2268 | "key", |
| 2269 | "createdAt", |
| 2270 | "updatedAt" |
| 2271 | ], |
| 2272 | "properties": { |
| 2273 | "id": { |
| 2274 | "type": "string" |
| 2275 | }, |
| 2276 | "key": { |
| 2277 | "type": "string" |
| 2278 | }, |
| 2279 | "createdAt": { |
| 2280 | "type": "string", |
| 2281 | "format": "date-time" |
| 2282 | }, |
| 2283 | "updatedAt": { |
| 2284 | "type": "string", |
| 2285 | "format": "date-time" |
| 2286 | } |
| 2287 | } |
| 2288 | }, |
| 2289 | "value": { |
| 2290 | "type": "string" |
| 2291 | } |
| 2292 | } |
| 2293 | } |
| 2294 | } |
| 2295 | }, |
| 2296 | "WorkspaceAppOauthConnectionsResponse": { |
| 2297 | "type": "object", |
| 2298 | "required": [ |
| 2299 | "data" |
| 2300 | ], |
| 2301 | "properties": { |
| 2302 | "data": { |
| 2303 | "type": "object", |
| 2304 | "required": [ |
| 2305 | "install", |
| 2306 | "connections", |
| 2307 | "permissions" |
| 2308 | ], |
| 2309 | "properties": { |
| 2310 | "install": { |
| 2311 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 2312 | }, |
| 2313 | "connections": { |
| 2314 | "type": "array", |
| 2315 | "items": { |
| 2316 | "type": "object", |
| 2317 | "required": [ |
| 2318 | "id", |
| 2319 | "providerKey", |
| 2320 | "externalAccountId", |
| 2321 | "scopes", |
| 2322 | "tokenExpiresAt", |
| 2323 | "createdAt", |
| 2324 | "updatedAt" |
| 2325 | ], |
| 2326 | "properties": { |
| 2327 | "id": { |
| 2328 | "type": "string" |
| 2329 | }, |
| 2330 | "providerKey": { |
| 2331 | "type": "string" |
| 2332 | }, |
| 2333 | "externalAccountId": { |
| 2334 | "type": [ |
| 2335 | "string", |
| 2336 | "null" |
| 2337 | ] |
| 2338 | }, |
| 2339 | "scopes": { |
| 2340 | "type": "array", |
| 2341 | "items": { |
| 2342 | "type": "string" |
| 2343 | } |
| 2344 | }, |
| 2345 | "tokenExpiresAt": { |
| 2346 | "type": [ |
| 2347 | "string", |
| 2348 | "null" |
| 2349 | ], |
| 2350 | "format": "date-time" |
| 2351 | }, |
| 2352 | "createdAt": { |
| 2353 | "type": "string", |
| 2354 | "format": "date-time" |
| 2355 | }, |
| 2356 | "updatedAt": { |
| 2357 | "type": "string", |
| 2358 | "format": "date-time" |
| 2359 | } |
| 2360 | } |
| 2361 | } |
| 2362 | }, |
| 2363 | "permissions": { |
| 2364 | "type": "object", |
| 2365 | "required": [ |
| 2366 | "canManageApps" |
| 2367 | ], |
| 2368 | "properties": { |
| 2369 | "canManageApps": { |
| 2370 | "type": "boolean" |
| 2371 | } |
| 2372 | } |
| 2373 | } |
| 2374 | } |
| 2375 | } |
| 2376 | } |
| 2377 | }, |
| 2378 | "CreateWorkspaceAppOauthConnectionResponse": { |
| 2379 | "type": "object", |
| 2380 | "required": [ |
| 2381 | "data" |
| 2382 | ], |
| 2383 | "properties": { |
| 2384 | "data": { |
| 2385 | "type": "object", |
| 2386 | "required": [ |
| 2387 | "connection" |
| 2388 | ], |
| 2389 | "properties": { |
| 2390 | "connection": { |
| 2391 | "type": "object", |
| 2392 | "required": [ |
| 2393 | "id", |
| 2394 | "providerKey", |
| 2395 | "externalAccountId", |
| 2396 | "scopes", |
| 2397 | "tokenExpiresAt", |
| 2398 | "createdAt", |
| 2399 | "updatedAt" |
| 2400 | ], |
| 2401 | "properties": { |
| 2402 | "id": { |
| 2403 | "type": "string" |
| 2404 | }, |
| 2405 | "providerKey": { |
| 2406 | "type": "string" |
| 2407 | }, |
| 2408 | "externalAccountId": { |
| 2409 | "type": [ |
| 2410 | "string", |
| 2411 | "null" |
| 2412 | ] |
| 2413 | }, |
| 2414 | "scopes": { |
| 2415 | "type": "array", |
| 2416 | "items": { |
| 2417 | "type": "string" |
| 2418 | } |
| 2419 | }, |
| 2420 | "tokenExpiresAt": { |
| 2421 | "type": [ |
| 2422 | "string", |
| 2423 | "null" |
| 2424 | ], |
| 2425 | "format": "date-time" |
| 2426 | }, |
| 2427 | "createdAt": { |
| 2428 | "type": "string", |
| 2429 | "format": "date-time" |
| 2430 | }, |
| 2431 | "updatedAt": { |
| 2432 | "type": "string", |
| 2433 | "format": "date-time" |
| 2434 | } |
| 2435 | } |
| 2436 | } |
| 2437 | } |
| 2438 | } |
| 2439 | } |
| 2440 | }, |
| 2441 | "WorkspaceAppDeliveriesResponse": { |
| 2442 | "type": "object", |
| 2443 | "required": [ |
| 2444 | "data" |
| 2445 | ], |
| 2446 | "properties": { |
| 2447 | "data": { |
| 2448 | "type": "object", |
| 2449 | "required": [ |
| 2450 | "install", |
| 2451 | "deliveries", |
| 2452 | "permissions" |
| 2453 | ], |
| 2454 | "properties": { |
| 2455 | "install": { |
| 2456 | "$ref": "#/components/schemas/InstalledAppSummary" |
| 2457 | }, |
| 2458 | "deliveries": { |
| 2459 | "type": "array", |
| 2460 | "items": { |
| 2461 | "type": "object", |
| 2462 | "required": [ |
| 2463 | "id", |
| 2464 | "eventType", |
| 2465 | "targetUrl", |
| 2466 | "status", |
| 2467 | "attemptCount", |
| 2468 | "lastStatusCode", |
| 2469 | "createdAt", |
| 2470 | "updatedAt" |
| 2471 | ], |
| 2472 | "properties": { |
| 2473 | "id": { |
| 2474 | "type": "string" |
| 2475 | }, |
| 2476 | "eventType": { |
| 2477 | "type": "string" |
| 2478 | }, |
| 2479 | "targetUrl": { |
| 2480 | "type": "string" |
| 2481 | }, |
| 2482 | "status": { |
| 2483 | "type": "string" |
| 2484 | }, |
| 2485 | "attemptCount": { |
| 2486 | "type": "integer" |
| 2487 | }, |
| 2488 | "lastStatusCode": { |
| 2489 | "type": [ |
| 2490 | "integer", |
| 2491 | "null" |
| 2492 | ] |
| 2493 | }, |
| 2494 | "createdAt": { |
| 2495 | "type": "string", |
| 2496 | "format": "date-time" |
| 2497 | }, |
| 2498 | "updatedAt": { |
| 2499 | "type": "string", |
| 2500 | "format": "date-time" |
| 2501 | } |
| 2502 | } |
| 2503 | } |
| 2504 | }, |
| 2505 | "permissions": { |
| 2506 | "type": "object", |
| 2507 | "required": [ |
| 2508 | "canManageApps" |
| 2509 | ], |
| 2510 | "properties": { |
| 2511 | "canManageApps": { |
| 2512 | "type": "boolean" |
| 2513 | } |
| 2514 | } |
| 2515 | } |
| 2516 | } |
| 2517 | } |
| 2518 | } |
| 2519 | }, |
| 2520 | "SendWorkspaceAppTestDeliveryResponse": { |
| 2521 | "type": "object", |
| 2522 | "required": [ |
| 2523 | "data" |
| 2524 | ], |
| 2525 | "properties": { |
| 2526 | "data": { |
| 2527 | "type": "object", |
| 2528 | "required": [ |
| 2529 | "delivery" |
| 2530 | ], |
| 2531 | "properties": { |
| 2532 | "delivery": { |
| 2533 | "type": "object", |
| 2534 | "required": [ |
| 2535 | "id", |
| 2536 | "eventType", |
| 2537 | "targetUrl", |
| 2538 | "status", |
| 2539 | "attemptCount", |
| 2540 | "lastStatusCode", |
| 2541 | "createdAt", |
| 2542 | "updatedAt" |
| 2543 | ], |
| 2544 | "properties": { |
| 2545 | "id": { |
| 2546 | "type": "string" |
| 2547 | }, |
| 2548 | "eventType": { |
| 2549 | "type": "string" |
| 2550 | }, |
| 2551 | "targetUrl": { |
| 2552 | "type": "string" |
| 2553 | }, |
| 2554 | "status": { |
| 2555 | "type": "string" |
| 2556 | }, |
| 2557 | "attemptCount": { |
| 2558 | "type": "integer" |
| 2559 | }, |
| 2560 | "lastStatusCode": { |
| 2561 | "type": [ |
| 2562 | "integer", |
| 2563 | "null" |
| 2564 | ] |
| 2565 | }, |
| 2566 | "createdAt": { |
| 2567 | "type": "string", |
| 2568 | "format": "date-time" |
| 2569 | }, |
| 2570 | "updatedAt": { |
| 2571 | "type": "string", |
| 2572 | "format": "date-time" |
| 2573 | } |
| 2574 | } |
| 2575 | } |
| 2576 | } |
| 2577 | } |
| 2578 | } |
| 2579 | }, |
| 2580 | "AppFileDocumentResponse": { |
| 2581 | "type": "object", |
| 2582 | "required": [ |
| 2583 | "data" |
| 2584 | ], |
| 2585 | "properties": { |
| 2586 | "data": { |
| 2587 | "type": "object", |
| 2588 | "required": [ |
| 2589 | "file", |
| 2590 | "document", |
| 2591 | "version", |
| 2592 | "capabilities" |
| 2593 | ], |
| 2594 | "properties": { |
| 2595 | "file": { |
| 2596 | "type": "object", |
| 2597 | "required": [ |
| 2598 | "id", |
| 2599 | "name", |
| 2600 | "fileType", |
| 2601 | "appKey", |
| 2602 | "appName", |
| 2603 | "typeLabel", |
| 2604 | "openHref", |
| 2605 | "updatedAt" |
| 2606 | ], |
| 2607 | "properties": { |
| 2608 | "id": { |
| 2609 | "type": "string" |
| 2610 | }, |
| 2611 | "name": { |
| 2612 | "type": "string" |
| 2613 | }, |
| 2614 | "fileType": { |
| 2615 | "type": "string" |
| 2616 | }, |
| 2617 | "appKey": { |
| 2618 | "type": "string" |
| 2619 | }, |
| 2620 | "appName": { |
| 2621 | "type": "string" |
| 2622 | }, |
| 2623 | "typeLabel": { |
| 2624 | "type": "string" |
| 2625 | }, |
| 2626 | "openHref": { |
| 2627 | "type": "string" |
| 2628 | }, |
| 2629 | "updatedAt": { |
| 2630 | "type": "string", |
| 2631 | "format": "date-time" |
| 2632 | } |
| 2633 | } |
| 2634 | }, |
| 2635 | "document": { |
| 2636 | "type": "object", |
| 2637 | "additionalProperties": true |
| 2638 | }, |
| 2639 | "version": { |
| 2640 | "type": "integer" |
| 2641 | }, |
| 2642 | "capabilities": { |
| 2643 | "type": "object", |
| 2644 | "required": [ |
| 2645 | "canRead", |
| 2646 | "canWrite", |
| 2647 | "canManage" |
| 2648 | ], |
| 2649 | "properties": { |
| 2650 | "canRead": { |
| 2651 | "type": "boolean" |
| 2652 | }, |
| 2653 | "canWrite": { |
| 2654 | "type": "boolean" |
| 2655 | }, |
| 2656 | "canManage": { |
| 2657 | "type": "boolean" |
| 2658 | } |
| 2659 | } |
| 2660 | } |
| 2661 | } |
| 2662 | } |
| 2663 | } |
| 2664 | }, |
| 2665 | "AppFileDocumentUpdateResponse": { |
| 2666 | "type": "object", |
| 2667 | "required": [ |
| 2668 | "data" |
| 2669 | ], |
| 2670 | "properties": { |
| 2671 | "data": { |
| 2672 | "type": "object", |
| 2673 | "required": [ |
| 2674 | "document", |
| 2675 | "version", |
| 2676 | "updatedAt" |
| 2677 | ], |
| 2678 | "properties": { |
| 2679 | "document": { |
| 2680 | "type": "object", |
| 2681 | "additionalProperties": true |
| 2682 | }, |
| 2683 | "version": { |
| 2684 | "type": "integer" |
| 2685 | }, |
| 2686 | "updatedAt": { |
| 2687 | "type": "string", |
| 2688 | "format": "date-time" |
| 2689 | } |
| 2690 | } |
| 2691 | } |
| 2692 | } |
| 2693 | }, |
| 2694 | "CreateAppNotificationInput": { |
| 2695 | "type": "object", |
| 2696 | "required": [ |
| 2697 | "channelKey", |
| 2698 | "typeKey", |
| 2699 | "recipients", |
| 2700 | "title" |
| 2701 | ], |
| 2702 | "properties": { |
| 2703 | "channelKey": { |
| 2704 | "type": "string" |
| 2705 | }, |
| 2706 | "typeKey": { |
| 2707 | "type": "string" |
| 2708 | }, |
| 2709 | "recipients": { |
| 2710 | "type": "array", |
| 2711 | "items": { |
| 2712 | "type": "object", |
| 2713 | "required": [ |
| 2714 | "userId" |
| 2715 | ], |
| 2716 | "properties": { |
| 2717 | "userId": { |
| 2718 | "type": "string" |
| 2719 | } |
| 2720 | } |
| 2721 | } |
| 2722 | }, |
| 2723 | "title": { |
| 2724 | "type": "string" |
| 2725 | }, |
| 2726 | "body": { |
| 2727 | "type": "string" |
| 2728 | }, |
| 2729 | "targetUrl": { |
| 2730 | "type": "string" |
| 2731 | }, |
| 2732 | "icon": { |
| 2733 | "type": "string" |
| 2734 | }, |
| 2735 | "priority": { |
| 2736 | "type": "string" |
| 2737 | }, |
| 2738 | "dedupeKey": { |
| 2739 | "type": "string" |
| 2740 | }, |
| 2741 | "metadata": { |
| 2742 | "type": "object", |
| 2743 | "additionalProperties": true |
| 2744 | } |
| 2745 | } |
| 2746 | }, |
| 2747 | "UpsertAppIndexDocumentsInput": { |
| 2748 | "type": "object", |
| 2749 | "required": [ |
| 2750 | "documents" |
| 2751 | ], |
| 2752 | "properties": { |
| 2753 | "documents": { |
| 2754 | "type": "array", |
| 2755 | "items": { |
| 2756 | "type": "object", |
| 2757 | "required": [ |
| 2758 | "documentKey", |
| 2759 | "documentType", |
| 2760 | "title" |
| 2761 | ], |
| 2762 | "properties": { |
| 2763 | "documentKey": { |
| 2764 | "type": "string" |
| 2765 | }, |
| 2766 | "documentType": { |
| 2767 | "type": "string" |
| 2768 | }, |
| 2769 | "fileId": { |
| 2770 | "type": "string" |
| 2771 | }, |
| 2772 | "title": { |
| 2773 | "type": "string" |
| 2774 | }, |
| 2775 | "body": { |
| 2776 | "type": "string" |
| 2777 | }, |
| 2778 | "url": { |
| 2779 | "type": "string" |
| 2780 | }, |
| 2781 | "metadata": { |
| 2782 | "type": "object", |
| 2783 | "additionalProperties": true |
| 2784 | }, |
| 2785 | "visibilityMode": { |
| 2786 | "type": "string" |
| 2787 | }, |
| 2788 | "visibility": { |
| 2789 | "type": "array", |
| 2790 | "items": { |
| 2791 | "type": "object", |
| 2792 | "required": [ |
| 2793 | "subjectType", |
| 2794 | "subjectId" |
| 2795 | ], |
| 2796 | "properties": { |
| 2797 | "subjectType": { |
| 2798 | "type": "string" |
| 2799 | }, |
| 2800 | "subjectId": { |
| 2801 | "type": "string" |
| 2802 | } |
| 2803 | } |
| 2804 | } |
| 2805 | } |
| 2806 | } |
| 2807 | } |
| 2808 | } |
| 2809 | } |
| 2810 | }, |
| 2811 | "UpsertAppIndexDocumentsResponse": { |
| 2812 | "type": "object", |
| 2813 | "required": [ |
| 2814 | "data" |
| 2815 | ], |
| 2816 | "properties": { |
| 2817 | "data": { |
| 2818 | "type": "object", |
| 2819 | "required": [ |
| 2820 | "documents" |
| 2821 | ], |
| 2822 | "properties": { |
| 2823 | "documents": { |
| 2824 | "type": "array", |
| 2825 | "items": { |
| 2826 | "type": "object", |
| 2827 | "required": [ |
| 2828 | "id", |
| 2829 | "documentKey", |
| 2830 | "visibilityMode" |
| 2831 | ], |
| 2832 | "properties": { |
| 2833 | "id": { |
| 2834 | "type": "string" |
| 2835 | }, |
| 2836 | "documentKey": { |
| 2837 | "type": "string" |
| 2838 | }, |
| 2839 | "visibilityMode": { |
| 2840 | "type": "string" |
| 2841 | } |
| 2842 | } |
| 2843 | } |
| 2844 | } |
| 2845 | } |
| 2846 | } |
| 2847 | } |
| 2848 | }, |
| 2849 | "DeleteAppIndexDocumentsInput": { |
| 2850 | "type": "object", |
| 2851 | "required": [ |
| 2852 | "documentKeys" |
| 2853 | ], |
| 2854 | "properties": { |
| 2855 | "documentKeys": { |
| 2856 | "type": "array", |
| 2857 | "items": { |
| 2858 | "type": "string" |
| 2859 | } |
| 2860 | } |
| 2861 | } |
| 2862 | }, |
| 2863 | "DeleteAppIndexDocumentsResponse": { |
| 2864 | "type": "object", |
| 2865 | "required": [ |
| 2866 | "data" |
| 2867 | ], |
| 2868 | "properties": { |
| 2869 | "data": { |
| 2870 | "type": "object", |
| 2871 | "required": [ |
| 2872 | "deleted" |
| 2873 | ], |
| 2874 | "properties": { |
| 2875 | "deleted": { |
| 2876 | "type": "array", |
| 2877 | "items": { |
| 2878 | "type": "object", |
| 2879 | "required": [ |
| 2880 | "id", |
| 2881 | "documentKey" |
| 2882 | ], |
| 2883 | "properties": { |
| 2884 | "id": { |
| 2885 | "type": "string" |
| 2886 | }, |
| 2887 | "documentKey": { |
| 2888 | "type": "string" |
| 2889 | } |
| 2890 | } |
| 2891 | } |
| 2892 | } |
| 2893 | } |
| 2894 | } |
| 2895 | } |
| 2896 | }, |
| 2897 | "EmitAppAmbientEventsInput": { |
| 2898 | "type": "object", |
| 2899 | "required": [ |
| 2900 | "events" |
| 2901 | ], |
| 2902 | "properties": { |
| 2903 | "events": { |
| 2904 | "type": "array", |
| 2905 | "items": { |
| 2906 | "type": "object", |
| 2907 | "required": [ |
| 2908 | "sourceKind", |
| 2909 | "action", |
| 2910 | "entityType", |
| 2911 | "entityId", |
| 2912 | "dedupeKey" |
| 2913 | ], |
| 2914 | "properties": { |
| 2915 | "sourceKind": { |
| 2916 | "type": "string" |
| 2917 | }, |
| 2918 | "action": { |
| 2919 | "type": "string" |
| 2920 | }, |
| 2921 | "entityType": { |
| 2922 | "type": "string" |
| 2923 | }, |
| 2924 | "entityId": { |
| 2925 | "type": "string" |
| 2926 | }, |
| 2927 | "actorUserId": { |
| 2928 | "type": "string" |
| 2929 | }, |
| 2930 | "containerType": { |
| 2931 | "type": "string" |
| 2932 | }, |
| 2933 | "containerId": { |
| 2934 | "type": "string" |
| 2935 | }, |
| 2936 | "occurredAt": { |
| 2937 | "type": "string", |
| 2938 | "format": "date-time" |
| 2939 | }, |
| 2940 | "dedupeKey": { |
| 2941 | "type": "string" |
| 2942 | }, |
| 2943 | "payload": { |
| 2944 | "type": "object", |
| 2945 | "additionalProperties": true |
| 2946 | }, |
| 2947 | "metadata": { |
| 2948 | "type": "object", |
| 2949 | "additionalProperties": true |
| 2950 | }, |
| 2951 | "schemaVersion": { |
| 2952 | "type": "integer" |
| 2953 | } |
| 2954 | } |
| 2955 | } |
| 2956 | } |
| 2957 | } |
| 2958 | }, |
| 2959 | "EmitAppAmbientEventsResponse": { |
| 2960 | "type": "object", |
| 2961 | "required": [ |
| 2962 | "data" |
| 2963 | ], |
| 2964 | "properties": { |
| 2965 | "data": { |
| 2966 | "type": "object", |
| 2967 | "required": [ |
| 2968 | "events" |
| 2969 | ], |
| 2970 | "properties": { |
| 2971 | "events": { |
| 2972 | "type": "array", |
| 2973 | "items": { |
| 2974 | "type": "object", |
| 2975 | "required": [ |
| 2976 | "id", |
| 2977 | "dedupeKey" |
| 2978 | ], |
| 2979 | "properties": { |
| 2980 | "id": { |
| 2981 | "type": "string" |
| 2982 | }, |
| 2983 | "dedupeKey": { |
| 2984 | "type": "string" |
| 2985 | } |
| 2986 | } |
| 2987 | } |
| 2988 | } |
| 2989 | } |
| 2990 | } |
| 2991 | } |
| 2992 | } |
| 2993 | } |
| 2994 | } |
| 2995 | } |
| 2996 |