Skip to content

Commit f484fde

Browse files
1 parent 233a5e1 commit f484fde

File tree

1 file changed

+29
-124
lines changed

1 file changed

+29
-124
lines changed

openapi/swagger.json

Lines changed: 29 additions & 124 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,30 @@
55
"version": ""
66
},
77
"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+
},
932
"responses": {},
1033
"parameters": {},
1134
"examples": {},
@@ -321,7 +344,7 @@
321344
"columns"
322345
],
323346
"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.",
325348
"example": {
326349
"columns": [
327350
{
@@ -350,26 +373,7 @@
350373
"rows": {
351374
"anyOf": [
352375
{
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```"
373377
},
374378
{
375379
"type": "object",
@@ -392,52 +396,12 @@
392396
},
393397
"required": [
394398
"name",
395-
"schema",
396399
"rows"
397400
],
398401
"additionalProperties": false
399402
},
400403
{
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```"
441405
}
442406
]
443407
}
@@ -737,26 +701,7 @@
737701
"rows": {
738702
"anyOf": [
739703
{
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```"
760705
},
761706
{
762707
"type": "object",
@@ -778,52 +723,12 @@
778723
}
779724
},
780725
"required": [
781-
"schema",
782726
"rows"
783727
],
784728
"additionalProperties": false
785729
},
786730
{
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```"
827732
}
828733
]
829734
}

0 commit comments

Comments
 (0)