Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document new download options and ability to use table ref instead of tableId #275

Merged
merged 3 commits into from
Oct 20, 2023
Merged

Document new download options and ability to use table ref instead of tableId #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad35de6
rebuild api.md
alexmojaki Oct 18, 2023
a74156e
Document options for downloading documents
alexmojaki Oct 18, 2023
8e0f0f4
Update description of tableId path param
alexmojaki Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion api/grist.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,18 @@ paths:
schema:
$ref: "#/components/schemas/DocKey"
required: true
- in: query
name: nohistory
schema:
type: boolean
description: "Remove document history (can significantly reduce file size)"
required: false
- in: query
name: template
schema:
type: boolean
description: "Remove all data and history but keep the structure to use the document as a template"
required: false
responses:
200:
description: A document's content in Sqlite form
Expand Down Expand Up @@ -2108,7 +2120,7 @@ components:
name: tableId
schema:
type: string
description: name of a table (normalized)
description: normalized table name (see `TABLE ID` in Raw Data) or numeric row ID in `_grist_Tables`
required: true
docIdPathParam:
in: path
Expand Down
Loading
Loading