Add documentation for new table endpoints /create and /insert #44
Conversation
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
vegarsti
changed the title
There was a problem hiding this comment.
Amazing @vegarsti ! I thoroughly read through it all.
I'm a bit torn between these two:
- We're still in alpha/beta, so lets not overthink.
- It is very hard to forget to update the docs once they are there, so we should make sure we get them right.
What I must say though is that what we are writing here is incredibly important and we need to take good care of our documentation. Things like ordering of endpoints, messages like "we recommend using X over Y" can change the KRs of the entire company.
| } | ||
| } | ||
| } | ||
| }, | ||
| "/v1/table/upload/csv": { | ||
| "post": { | ||
| "summary": "Upload a CSV as a table in Dune.", | ||
| "description": "This API allows for anyone to upload a CSV as a table in Dune. The size limit per upload is currently 200MB. Your storage is limited by plan, 1MB on free, 15GB on plus, and 50GB on premium.", |
There was a problem hiding this comment.
What messaging can we provide to say that we recommend using the other endpoints?
Should we mention something about schema inferencing?
There was a problem hiding this comment.
Added a Warning to the existing Upload endpoint about it being in maintenance mode, and they should consider using create and insert.
| } | ||
| } | ||
| }, | ||
| "is_private": { |
There was a problem hiding this comment.
I'm inclined to make this required to make sure people are explicit about creating a public table.
I'm also thinking about calling this argument public instead of is_private to make it clear that not private means that it is open for everyone.
Would be interesting to hear what @andrewhong5297 has to say about this.
Co-authored-by: André <36137130+a-monteiro@users.noreply.github.com>
This PR adds documentation for the new beta endpoints /create and /insert, for creating a table, and inserting into (appending to) a table.
Browse docs here:
/create/insertCloses PRO-933.