Skip to content

Commit 07ab560

Browse files
committed
Merge remote-tracking branch 'origin/main' into api-update-glide-pr-29768
2 parents f484fde + 4c369e0 commit 07ab560

File tree

6 files changed

+40
-0
lines changed

6 files changed

+40
-0
lines changed

api-reference/v2/resources/changelog.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Glide API Changelog
33
sidebarTitle: Changelog
44
---
55

6+
### September 18, 2024
7+
8+
- Endpoints that receive tabular data can now accept CSV and TSV request bodies.
9+
610
### September 13, 2024
711

812
- Introduced a new "Limits" document that outlines rate and operational limits for the API.

api-reference/v2/stashing/put-stashes-serial.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ openapi: put /stashes/{stashID}/{serial}
55

66
When using large datasets with the Glide API, it may be necessary to break them into smaller chunks for performance and reliability. We call this process "stashing."
77

8+
Tabular data may be stashed in JSON, CSV, or TSV format.
9+
810
<Tip>
911
To learn more about stashing and how to use it to work with large datasets, please see our [introduction to stashing](/api-reference/v2/stashing/introduction).
1012
</Tip>

api-reference/v2/tables/post-table-rows.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ openapi: post /tables/{tableID}/rows
55

66
Add row data to an existing Big Table.
77

8+
Row data may be passed in JSON, CSV, or TSV format.
9+
810
## Examples
911

1012
<AccordionGroup>

api-reference/v2/tables/post-tables.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ openapi: post /tables
55

66
Create a new Big Table, define its structure, and (optionally) populate it with data.
77

8+
When using a CSV or TSV request body, the name of the table must be passed as a query parameter and the schema of the table is inferred from the content. Alternatively, the CSV/TSV content may be [stashed](/api-reference/v2/stashing/introduction), and then the schema and name may be passed in the regular JSON payload.
9+
810
## Examples
911

1012
<AccordionGroup>

api-reference/v2/tables/put-tables.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ openapi: put /tables/{tableID}
55

66
Overwrite an existing Big Table by clearing all rows and adding new data. You can also update the table schema.
77

8+
When using a CSV or TSV request body, you cannot pass a schema. The current schema will be used. If you need to update the schema, use the `onSchemaError=updateSchema` query parameter, or [stash](/api-reference/v2/stashing/introduction) the CSV/TSV data and pass a JSON request body.
9+
810
<Warning>
911
This is a destructive operation that cannot be undone.
1012
</Warning>

openapi/swagger.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,20 @@
413413
"example": "Name,Age,Birthday\nAlice,25,2024-08-29T09:46:16.722Z\nBob,30,2020-01-15T09:00:16.722Z"
414414
}
415415
},
416+
"text/tab-separated-values": {
417+
"schema": {
418+
"type": "string",
419+
"description": "A TSV string. The first line is column IDs, and each subsequent line is a row of data. The schema will be inferred from the data. The name of the table must be passed in the query parameter `name`.",
420+
"example": "Name\tAge\tBirthday\nAlice\t25\t2024-08-29T09:46:16.722Z\nBob\t30\t2020-01-15T09:00:16.722Z"
421+
}
422+
},
423+
"text/csv": {
424+
"schema": {
425+
"type": "string",
426+
"description": "A CSV string. The first line is column IDs, and each subsequent line is a row of data. The schema will be inferred from the data. The name of the table must be passed in the query parameter `name`.",
427+
"example": "Name,Age,Birthday\nAlice,25,2024-08-29T09:46:16.722Z\nBob,30,2020-01-15T09:00:16.722Z"
428+
}
429+
},
416430
"text/tab-separated-values": {
417431
"schema": {
418432
"type": "string",
@@ -740,6 +754,20 @@
740754
"example": "Name,Age,Birthday\nAlice,25,2024-08-29T09:46:16.722Z\nBob,30,2020-01-15T09:00:16.722Z"
741755
}
742756
},
757+
"text/tab-separated-values": {
758+
"schema": {
759+
"type": "string",
760+
"description": "A TSV string. The first line is column IDs, and each subsequent line is a row of data.",
761+
"example": "Name\tAge\tBirthday\nAlice\t25\t2024-08-29T09:46:16.722Z\nBob\t30\t2020-01-15T09:00:16.722Z"
762+
}
763+
},
764+
"text/csv": {
765+
"schema": {
766+
"type": "string",
767+
"description": "A CSV string. The first line is column IDs, and each subsequent line is a row of data.",
768+
"example": "Name,Age,Birthday\nAlice,25,2024-08-29T09:46:16.722Z\nBob,30,2020-01-15T09:00:16.722Z"
769+
}
770+
},
743771
"text/tab-separated-values": {
744772
"schema": {
745773
"type": "string",

0 commit comments

Comments
 (0)