|
5 | 5 | "version": "" |
6 | 6 | }, |
7 | 7 | "components": { |
8 | | - "schemas": {}, |
| 8 | + "schemas": { |
| 9 | + "A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```": { |
| 10 | + "type": "array", |
| 11 | + "items": { |
| 12 | + "type": "object", |
| 13 | + "additionalProperties": {} |
| 14 | + }, |
| 15 | + "description": "A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```", |
| 16 | + "example": [ |
| 17 | + { |
| 18 | + "fullName": "Alex Bard", |
| 19 | + "invoiceDate": "2024-07-29T14:04:15.561Z", |
| 20 | + "totalAmount": 34.5, |
| 21 | + "amountPaid": 0 |
| 22 | + }, |
| 23 | + { |
| 24 | + "fullName": "Alicia Hines", |
| 25 | + "invoiceDate": "2023-06-15T10:30:00.000Z", |
| 26 | + "totalAmount": 50.75, |
| 27 | + "amountPaid": 20 |
| 28 | + } |
| 29 | + ] |
| 30 | + } |
| 31 | + }, |
9 | 32 | "responses": {}, |
10 | 33 | "parameters": {}, |
11 | 34 | "examples": {}, |
|
321 | 344 | "columns" |
322 | 345 | ], |
323 | 346 | "additionalProperties": false, |
324 | | - "description": "The schema of the table as a collection of column definitions", |
| 347 | + "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.", |
325 | 348 | "example": { |
326 | 349 | "columns": [ |
327 | 350 | { |
|
350 | 373 | "rows": { |
351 | 374 | "anyOf": [ |
352 | 375 | { |
353 | | - "type": "array", |
354 | | - "items": { |
355 | | - "type": "object", |
356 | | - "additionalProperties": {} |
357 | | - }, |
358 | | - "description": "A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```", |
359 | | - "example": [ |
360 | | - { |
361 | | - "fullName": "Alex Bard", |
362 | | - "invoiceDate": "2024-07-29T14:04:15.561Z", |
363 | | - "totalAmount": 34.5, |
364 | | - "amountPaid": 0 |
365 | | - }, |
366 | | - { |
367 | | - "fullName": "Alicia Hines", |
368 | | - "invoiceDate": "2023-06-15T10:30:00.000Z", |
369 | | - "totalAmount": 50.75, |
370 | | - "amountPaid": 20 |
371 | | - } |
372 | | - ] |
| 376 | + "$ref": "#/components/schemas/A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```" |
373 | 377 | }, |
374 | 378 | { |
375 | 379 | "type": "object", |
|
392 | 396 | }, |
393 | 397 | "required": [ |
394 | 398 | "name", |
395 | | - "schema", |
396 | 399 | "rows" |
397 | 400 | ], |
398 | 401 | "additionalProperties": false |
399 | 402 | }, |
400 | 403 | { |
401 | | - "anyOf": [ |
402 | | - { |
403 | | - "type": "array", |
404 | | - "items": { |
405 | | - "type": "object", |
406 | | - "additionalProperties": {} |
407 | | - }, |
408 | | - "description": "A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```", |
409 | | - "example": [ |
410 | | - { |
411 | | - "fullName": "Alex Bard", |
412 | | - "invoiceDate": "2024-07-29T14:04:15.561Z", |
413 | | - "totalAmount": 34.5, |
414 | | - "amountPaid": 0 |
415 | | - }, |
416 | | - { |
417 | | - "fullName": "Alicia Hines", |
418 | | - "invoiceDate": "2023-06-15T10:30:00.000Z", |
419 | | - "totalAmount": 50.75, |
420 | | - "amountPaid": 20 |
421 | | - } |
422 | | - ] |
423 | | - }, |
424 | | - { |
425 | | - "type": "object", |
426 | | - "properties": { |
427 | | - "$stashID": { |
428 | | - "type": "string", |
429 | | - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,255}$", |
430 | | - "description": "ID of the stash, e.g., `20240215-job32`", |
431 | | - "example": "20240215-job32" |
432 | | - } |
433 | | - }, |
434 | | - "required": [ |
435 | | - "$stashID" |
436 | | - ], |
437 | | - "additionalProperties": false, |
438 | | - "description": "A single reference to a [stash](/api-reference/v2/stashing) whose data should be used" |
439 | | - } |
440 | | - ] |
| 404 | + "$ref": "#/components/schemas/A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```" |
441 | 405 | } |
442 | 406 | ] |
443 | 407 | } |
|
737 | 701 | "rows": { |
738 | 702 | "anyOf": [ |
739 | 703 | { |
740 | | - "type": "array", |
741 | | - "items": { |
742 | | - "type": "object", |
743 | | - "additionalProperties": {} |
744 | | - }, |
745 | | - "description": "A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```", |
746 | | - "example": [ |
747 | | - { |
748 | | - "fullName": "Alex Bard", |
749 | | - "invoiceDate": "2024-07-29T14:04:15.561Z", |
750 | | - "totalAmount": 34.5, |
751 | | - "amountPaid": 0 |
752 | | - }, |
753 | | - { |
754 | | - "fullName": "Alicia Hines", |
755 | | - "invoiceDate": "2023-06-15T10:30:00.000Z", |
756 | | - "totalAmount": 50.75, |
757 | | - "amountPaid": 20 |
758 | | - } |
759 | | - ] |
| 704 | + "$ref": "#/components/schemas/A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```" |
760 | 705 | }, |
761 | 706 | { |
762 | 707 | "type": "object", |
|
778 | 723 | } |
779 | 724 | }, |
780 | 725 | "required": [ |
781 | | - "schema", |
782 | 726 | "rows" |
783 | 727 | ], |
784 | 728 | "additionalProperties": false |
785 | 729 | }, |
786 | 730 | { |
787 | | - "anyOf": [ |
788 | | - { |
789 | | - "type": "array", |
790 | | - "items": { |
791 | | - "type": "object", |
792 | | - "additionalProperties": {} |
793 | | - }, |
794 | | - "description": "A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```", |
795 | | - "example": [ |
796 | | - { |
797 | | - "fullName": "Alex Bard", |
798 | | - "invoiceDate": "2024-07-29T14:04:15.561Z", |
799 | | - "totalAmount": 34.5, |
800 | | - "amountPaid": 0 |
801 | | - }, |
802 | | - { |
803 | | - "fullName": "Alicia Hines", |
804 | | - "invoiceDate": "2023-06-15T10:30:00.000Z", |
805 | | - "totalAmount": 50.75, |
806 | | - "amountPaid": 20 |
807 | | - } |
808 | | - ] |
809 | | - }, |
810 | | - { |
811 | | - "type": "object", |
812 | | - "properties": { |
813 | | - "$stashID": { |
814 | | - "type": "string", |
815 | | - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,255}$", |
816 | | - "description": "ID of the stash, e.g., `20240215-job32`", |
817 | | - "example": "20240215-job32" |
818 | | - } |
819 | | - }, |
820 | | - "required": [ |
821 | | - "$stashID" |
822 | | - ], |
823 | | - "additionalProperties": false, |
824 | | - "description": "A single reference to a [stash](/api-reference/v2/stashing) whose data should be used" |
825 | | - } |
826 | | - ] |
| 731 | + "$ref": "#/components/schemas/A collection of row objects conforming to the schema of the table where keys are the column IDs and values are the column values:\n\n```json\n[\n\t{\n\t\t\"fullName\": \"Alex Bard\",\n\t\t\"invoiceDate\": \"2024-07-29T14:04:15.561Z\",\n\t\t\"totalAmount\": 34.50,\n\t\t\"amountPaid\": 0\n\t},\n\t{\n\t\t\"fullName\": \"Alicia Hines\",\n\t\t\"invoiceDate\": \"2023-06-15T10:30:00.000Z\",\n\t\t\"totalAmount\": 50.75,\n\t\t\"amountPaid\": 20\n\t}\n]\n```" |
827 | 732 | } |
828 | 733 | ] |
829 | 734 | } |
|
0 commit comments