Skip to content

Union mkdocs and api docs attempt 3 #1

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

Open
ghini10 wants to merge 24 commits into
base: add-table-docs
Choose a base branch
from
Open

Union mkdocs and api docs attempt 3 #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
4b41cd3
Example fixs (#20)
Feb 8, 2024
bfc2475
query results API: add pagination related field
msf Feb 12, 2024
f6b4970
start adding query result new fields for pagination
msf Feb 12, 2024
2b4840f
Capitalize start of the sentence
agaperste Feb 12, 2024
5b3bb8d
Merge pull request #21 from duneanalytics/miguel/eng-556-openapi-sche…
agaperste Feb 12, 2024
e519f70
Update openapi spec for pagination
RichardKeo Feb 12, 2024
0e15fbf
Merge pull request #22 from duneanalytics/update-pagination
agaperste Feb 12, 2024
27fb51c
adding a page for pagination doc, most of the explanation done, pendi…
agaperste Feb 12, 2024
1157b17
finished adding example request and reponse for pagination page, and …
agaperste Feb 13, 2024
f0bb27d
addressing PR comments
agaperste Feb 13, 2024
dddbba9
minor correction for json response
agaperste Feb 13, 2024
dd4314f
Merge pull request #23 from duneanalytics/pagination-docs
agaperste Feb 13, 2024
112ad6c
small improvements to pagination page
msf Feb 15, 2024
d6f326f
query execution API: a slew of small fixes.
msf Feb 15, 2024
138afa4
fix definition for queryParameters
msf Feb 15, 2024
53040c7
Update query-parameters.mdx
andrewhong5297 Feb 15, 2024
2a7f45f
apikey wording and query param optional field
msf Feb 15, 2024
f1b2f4f
other minor edits on the mdx files
msf Feb 15, 2024
627b073
fix semantic typo
msf Feb 15, 2024
8807926
formatting update
agaperste Feb 15, 2024
c907dc3
Update query-parameters.mdx
andrewhong5297 Feb 15, 2024
d2f9b2a
a few more fixes
msf Feb 15, 2024
e99d138
updating 1GB to 8GB; updating wording for pagination doc
agaperste Feb 15, 2024
381a37d
Merge pull request #24 from duneanalytics/msf-review
agaperste Feb 15, 2024
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
72 changes: 63 additions & 9 deletions api-reference/crud/crud-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"openapi": "3.0.1",
"info": {
"title": "OpenAPI for CRUD API",
"description": "API for create, read, update, and delete operations on Dune queries.",
"title": "OpenAPI for Query CRUD API",
"description": "API for Create, Read, Update, and Delete operations on Dune queries.",
"version": "1.0.0"
},
"servers": [
Expand All @@ -22,9 +22,18 @@
"schema": {
"type": "string"
},
"description": "API Key for accessing this service",
"description": "API Key for the service",
"required": true
},
{
"in": "query",
"name": "api_key",
"schema": {
"type": "string"
},
"description": "API Key for the service, alternative to using the HTTP header X-DUNE-API-KEY.",
"required": false
},
{
"in": "path",
"name": "queryId",
Expand Down Expand Up @@ -108,7 +117,7 @@
"schema": {
"type": "string"
},
"description": "API Key for accessing this service",
"description": "API Key for the service",
"required": true
},
{
Expand Down Expand Up @@ -223,8 +232,17 @@
"schema": {
"type": "string"
},
"description": "API Key for accessing this service",
"description": "API Key for the service",
"required": true
},
{
"in": "query",
"name": "api_key",
"schema": {
"type": "string"
},
"description": "API Key for the service, alternative to using the HTTP header X-DUNE-API-KEY.",
"required": false
}
],
"requestBody": {
Expand Down Expand Up @@ -319,9 +337,18 @@
"schema": {
"type": "string"
},
"description": "API Key for accessing this service",
"description": "API Key for the service",
"required": true
},
{
"in": "query",
"name": "api_key",
"schema": {
"type": "string"
},
"description": "API Key for the service, alternative to using the HTTP header X-DUNE-API-KEY.",
"required": false
},
{
"in": "path",
"name": "queryId",
Expand Down Expand Up @@ -414,9 +441,18 @@
"schema": {
"type": "string"
},
"description": "API Key for accessing this service",
"description": "API Key for the service",
"required": true
},
{
"in": "query",
"name": "api_key",
"schema": {
"type": "string"
},
"description": "API Key for the service, alternative to using the HTTP header X-DUNE-API-KEY.",
"required": false
},
{
"in": "path",
"name": "queryId",
Expand Down Expand Up @@ -509,9 +545,18 @@
"schema": {
"type": "string"
},
"description": "API Key for accessing this service",
"description": "API Key for the service",
"required": true
},
{
"in": "query",
"name": "api_key",
"schema": {
"type": "string"
},
"description": "API Key for the service, alternative to using the HTTP header X-DUNE-API-KEY.",
"required": false
},
{
"in": "path",
"name": "queryId",
Expand Down Expand Up @@ -614,9 +659,18 @@
"schema": {
"type": "string"
},
"description": "API Key for accessing this service",
"description": "API Key for the service",
"required": true
},
{
"in": "query",
"name": "api_key",
"schema": {
"type": "string"
},
"description": "API Key for the service, alternative to using the HTTP header X-DUNE-API-KEY.",
"required": false
},
{
"in": "path",
"name": "queryId",
Expand Down
2 changes: 1 addition & 1 deletion api-reference/overview/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Authentication
The Dune API relies on API keys for authentication. Your API key grants access and determines billing details for private queries, so safeguard it diligently!

## Generate an API key
In order to generate a new API key, go to settings -> API -> create new API key.
In order to generate a new API key, go to settings -> API -> create new API key.

<Note>
- Dune has two types of account: `user` account and `team` account. A team can have many users. A user can join many teams.
Expand Down
4 changes: 0 additions & 4 deletions api-reference/overview/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,6 @@ Yes!

The results storage period can be found on the API response on the “expires_at” field in the execution status and results body.

#### How much data can I retrieve in a single API result call?

There is currently a ~1GB limit. The API does not currently return an explicit error upon hitting this limit but will instead fail (timeout) when attempting to retrieve the results.

#### How do I import Dune data into a google sheet?

Use "Import Data" to import your CSV results into a google sheet using "api_key" as a param. (We advise against doing this any public document where your API key can be viewed and compromised.)
Expand Down
4 changes: 2 additions & 2 deletions api-reference/overview/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Dune's four core API offerings can be found below:
Execute queries and get results in JSON or CSV form
</Card>
<Card
title="CRUD (Create, Read, Update, Delete)"
title="Query CRUD (Create, Read, Update, Delete)"
icon="floppy-disk"
href="/api-reference/crud/endpoint/create"
>
Expand All @@ -35,4 +35,4 @@ Dune's four core API offerings can be found below:
>
Push Dune data into your own webhooks, on a custom set schedule
</Card>
</CardGroup>
</CardGroup>
Loading