|
159 | 159 | "zcJWnyI8Tbam21V34K8MNA", |
160 | 160 | "93a19-cf7c-44437-b8c1-e9acbbb" |
161 | 161 | ] |
| 162 | + }, |
| 163 | + "linkedAppIDs": { |
| 164 | + "type": "array", |
| 165 | + "items": { |
| 166 | + "type": "string" |
| 167 | + }, |
| 168 | + "description": "An array of appIDs which were successfully linked." |
162 | 169 | } |
163 | 170 | }, |
164 | 171 | "required": [ |
|
293 | 300 | }, |
294 | 301 | "required": false |
295 | 302 | }, |
| 303 | + { |
| 304 | + "name": "appsToLink", |
| 305 | + "in": "query", |
| 306 | + "schema": { |
| 307 | + "type": "array", |
| 308 | + "items": { |
| 309 | + "type": "string" |
| 310 | + }, |
| 311 | + "description": "An array of app IDs to link the new table to." |
| 312 | + }, |
| 313 | + "required": false |
| 314 | + }, |
296 | 315 | { |
297 | 316 | "name": "onSchemaError", |
298 | 317 | "in": "query", |
|
315 | 334 | "schema": { |
316 | 335 | "anyOf": [ |
317 | 336 | { |
318 | | - "type": "object", |
319 | | - "properties": { |
320 | | - "name": { |
321 | | - "type": "string", |
322 | | - "description": "Name of the table, e.g., `Invoices`", |
323 | | - "example": "Invoices" |
324 | | - }, |
325 | | - "schema": { |
| 337 | + "anyOf": [ |
| 338 | + { |
326 | 339 | "type": "object", |
327 | 340 | "properties": { |
328 | | - "columns": { |
329 | | - "type": "array", |
330 | | - "items": { |
331 | | - "type": "object", |
332 | | - "properties": { |
333 | | - "id": { |
334 | | - "type": "string", |
335 | | - "description": "Internal ID of the column, e.g., `fullName`. This value cannot be changed once created.", |
336 | | - "example": "fullName" |
337 | | - }, |
338 | | - "displayName": { |
339 | | - "type": "string", |
340 | | - "description": "Human-readable display name of the column, e.g., `Full Name`. Can be modified once created.", |
341 | | - "example": "Full Name" |
342 | | - }, |
343 | | - "type": { |
344 | | - "anyOf": [ |
345 | | - { |
| 341 | + "name": { |
| 342 | + "type": "string", |
| 343 | + "description": "Name of the table, e.g., `Invoices`", |
| 344 | + "example": "Invoices" |
| 345 | + }, |
| 346 | + "schema": { |
| 347 | + "type": "object", |
| 348 | + "properties": { |
| 349 | + "columns": { |
| 350 | + "type": "array", |
| 351 | + "items": { |
| 352 | + "type": "object", |
| 353 | + "properties": { |
| 354 | + "id": { |
346 | 355 | "type": "string", |
347 | | - "enum": [ |
348 | | - "string", |
349 | | - "uri", |
350 | | - "imageURI", |
351 | | - "audioURI", |
352 | | - "markdown", |
353 | | - "phoneNumber", |
354 | | - "emailAddress", |
355 | | - "emoji", |
356 | | - "date", |
357 | | - "time", |
358 | | - "dateTime", |
359 | | - "duration", |
360 | | - "number", |
361 | | - "boolean" |
362 | | - ] |
| 356 | + "description": "Internal ID of the column, e.g., `fullName`. This value cannot be changed once created.", |
| 357 | + "example": "fullName" |
363 | 358 | }, |
364 | | - { |
| 359 | + "displayName": { |
| 360 | + "type": "string", |
| 361 | + "description": "Human-readable display name of the column, e.g., `Full Name`. Can be modified once created.", |
| 362 | + "example": "Full Name" |
| 363 | + }, |
| 364 | + "type": { |
365 | 365 | "anyOf": [ |
366 | 366 | { |
367 | | - "type": "object", |
368 | | - "properties": { |
369 | | - "kind": { |
370 | | - "type": "string", |
371 | | - "enum": [ |
372 | | - "string", |
373 | | - "uri", |
374 | | - "imageURI", |
375 | | - "audioURI", |
376 | | - "markdown", |
377 | | - "phoneNumber", |
378 | | - "emailAddress", |
379 | | - "emoji", |
380 | | - "date", |
381 | | - "time", |
382 | | - "dateTime", |
383 | | - "duration", |
384 | | - "number", |
385 | | - "boolean" |
386 | | - ] |
387 | | - } |
388 | | - }, |
389 | | - "required": [ |
390 | | - "kind" |
391 | | - ], |
392 | | - "additionalProperties": false |
| 367 | + "type": "string", |
| 368 | + "enum": [ |
| 369 | + "string", |
| 370 | + "uri", |
| 371 | + "imageURI", |
| 372 | + "audioURI", |
| 373 | + "markdown", |
| 374 | + "phoneNumber", |
| 375 | + "emailAddress", |
| 376 | + "emoji", |
| 377 | + "date", |
| 378 | + "time", |
| 379 | + "dateTime", |
| 380 | + "duration", |
| 381 | + "number", |
| 382 | + "boolean" |
| 383 | + ] |
393 | 384 | }, |
394 | 385 | { |
395 | | - "type": "object", |
396 | | - "properties": { |
397 | | - "kind": { |
398 | | - "type": "string", |
399 | | - "enum": [ |
400 | | - "array" |
401 | | - ] |
402 | | - }, |
403 | | - "items": { |
| 386 | + "anyOf": [ |
| 387 | + { |
404 | 388 | "type": "object", |
405 | 389 | "properties": { |
406 | 390 | "kind": { |
|
427 | 411 | "kind" |
428 | 412 | ], |
429 | 413 | "additionalProperties": false |
| 414 | + }, |
| 415 | + { |
| 416 | + "type": "object", |
| 417 | + "properties": { |
| 418 | + "kind": { |
| 419 | + "type": "string", |
| 420 | + "enum": [ |
| 421 | + "array" |
| 422 | + ] |
| 423 | + }, |
| 424 | + "items": { |
| 425 | + "type": "object", |
| 426 | + "properties": { |
| 427 | + "kind": { |
| 428 | + "type": "string", |
| 429 | + "enum": [ |
| 430 | + "string", |
| 431 | + "uri", |
| 432 | + "imageURI", |
| 433 | + "audioURI", |
| 434 | + "markdown", |
| 435 | + "phoneNumber", |
| 436 | + "emailAddress", |
| 437 | + "emoji", |
| 438 | + "date", |
| 439 | + "time", |
| 440 | + "dateTime", |
| 441 | + "duration", |
| 442 | + "number", |
| 443 | + "boolean" |
| 444 | + ] |
| 445 | + } |
| 446 | + }, |
| 447 | + "required": [ |
| 448 | + "kind" |
| 449 | + ], |
| 450 | + "additionalProperties": false |
| 451 | + } |
| 452 | + }, |
| 453 | + "required": [ |
| 454 | + "kind", |
| 455 | + "items" |
| 456 | + ], |
| 457 | + "additionalProperties": false |
430 | 458 | } |
431 | | - }, |
432 | | - "required": [ |
433 | | - "kind", |
434 | | - "items" |
435 | | - ], |
436 | | - "additionalProperties": false |
| 459 | + ] |
437 | 460 | } |
438 | | - ] |
| 461 | + ], |
| 462 | + "description": "The type of the column." |
439 | 463 | } |
| 464 | + }, |
| 465 | + "required": [ |
| 466 | + "id", |
| 467 | + "type" |
440 | 468 | ], |
441 | | - "description": "The type of the column." |
| 469 | + "additionalProperties": false |
| 470 | + }, |
| 471 | + "description": "A collection of column definitions, in the order that they are to be displayed in the table." |
| 472 | + } |
| 473 | + }, |
| 474 | + "required": [ |
| 475 | + "columns" |
| 476 | + ], |
| 477 | + "additionalProperties": false, |
| 478 | + "description": "The schema of the table as a collection of column definitions. If this is not provided, the schema will be inferred from the data.", |
| 479 | + "example": { |
| 480 | + "columns": [ |
| 481 | + { |
| 482 | + "id": "fullName", |
| 483 | + "displayName": "Full Name", |
| 484 | + "type": "string" |
| 485 | + }, |
| 486 | + { |
| 487 | + "id": "invoiceDate", |
| 488 | + "displayName": "Invoice Date", |
| 489 | + "type": "dateTime" |
| 490 | + }, |
| 491 | + { |
| 492 | + "id": "totalAmount", |
| 493 | + "displayName": "Total", |
| 494 | + "type": "number" |
| 495 | + }, |
| 496 | + { |
| 497 | + "id": "amountPaid", |
| 498 | + "displayName": "Paid", |
| 499 | + "type": "number" |
442 | 500 | } |
| 501 | + ] |
| 502 | + } |
| 503 | + }, |
| 504 | + "rows": { |
| 505 | + "anyOf": [ |
| 506 | + { |
| 507 | + "$ref": "#/components/schemas/A_collection_of_row_objects" |
443 | 508 | }, |
444 | | - "required": [ |
445 | | - "id", |
446 | | - "type" |
447 | | - ], |
448 | | - "additionalProperties": false |
| 509 | + { |
| 510 | + "type": "object", |
| 511 | + "properties": { |
| 512 | + "$stashID": { |
| 513 | + "type": "string", |
| 514 | + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,255}$", |
| 515 | + "description": "ID of the stash, e.g., `20240215-job32`", |
| 516 | + "example": "20240215-job32" |
| 517 | + } |
| 518 | + }, |
| 519 | + "required": [ |
| 520 | + "$stashID" |
| 521 | + ], |
| 522 | + "additionalProperties": false, |
| 523 | + "description": "A single reference to a [stash](/api-reference/v2/stashing) whose data should be used." |
| 524 | + } |
| 525 | + ] |
| 526 | + }, |
| 527 | + "appsToLink": { |
| 528 | + "type": "array", |
| 529 | + "items": { |
| 530 | + "type": "string" |
449 | 531 | }, |
450 | | - "description": "A collection of column definitions, in the order that they are to be displayed in the table." |
| 532 | + "description": "An array of app IDs to link the new table to." |
451 | 533 | } |
452 | 534 | }, |
453 | 535 | "required": [ |
454 | | - "columns" |
| 536 | + "name", |
| 537 | + "rows" |
455 | 538 | ], |
456 | | - "additionalProperties": false, |
457 | | - "description": "The schema of the table as a collection of column definitions. If this is not provided, the schema will be inferred from the data.", |
458 | | - "example": { |
459 | | - "columns": [ |
460 | | - { |
461 | | - "id": "fullName", |
462 | | - "displayName": "Full Name", |
463 | | - "type": "string" |
464 | | - }, |
465 | | - { |
466 | | - "id": "invoiceDate", |
467 | | - "displayName": "Invoice Date", |
468 | | - "type": "dateTime" |
469 | | - }, |
470 | | - { |
471 | | - "id": "totalAmount", |
472 | | - "displayName": "Total", |
473 | | - "type": "number" |
474 | | - }, |
475 | | - { |
476 | | - "id": "amountPaid", |
477 | | - "displayName": "Paid", |
478 | | - "type": "number" |
479 | | - } |
480 | | - ] |
481 | | - } |
| 539 | + "additionalProperties": false |
482 | 540 | }, |
483 | | - "rows": { |
484 | | - "anyOf": [ |
485 | | - { |
486 | | - "$ref": "#/components/schemas/A_collection_of_row_objects" |
487 | | - }, |
488 | | - { |
489 | | - "type": "object", |
490 | | - "properties": { |
491 | | - "$stashID": { |
492 | | - "type": "string", |
493 | | - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,255}$", |
494 | | - "description": "ID of the stash, e.g., `20240215-job32`", |
495 | | - "example": "20240215-job32" |
496 | | - } |
497 | | - }, |
498 | | - "required": [ |
499 | | - "$stashID" |
500 | | - ], |
501 | | - "additionalProperties": false, |
502 | | - "description": "A single reference to a [stash](/api-reference/v2/stashing) whose data should be used." |
503 | | - } |
504 | | - ] |
| 541 | + { |
| 542 | + "$ref": "#/components/schemas/A_collection_of_row_objects" |
| 543 | + } |
| 544 | + ] |
| 545 | + }, |
| 546 | + { |
| 547 | + "type": "object", |
| 548 | + "properties": { |
| 549 | + "fileUrl": { |
| 550 | + "type": "string" |
505 | 551 | } |
506 | 552 | }, |
507 | 553 | "required": [ |
508 | | - "name", |
509 | | - "rows" |
| 554 | + "fileUrl" |
510 | 555 | ], |
511 | 556 | "additionalProperties": false |
512 | | - }, |
513 | | - { |
514 | | - "$ref": "#/components/schemas/A_collection_of_row_objects" |
515 | 557 | } |
516 | 558 | ] |
517 | 559 | } |
|
0 commit comments