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.

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

Spike: Explore adding a bunch of endpoints #10

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v20.11.0
6 changes: 6 additions & 0 deletions api-reference/v2/apps/create-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Create App
openapi: post /apps
---

Creates a new App.
6 changes: 6 additions & 0 deletions api-reference/v2/apps/get-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Get App
openapi: get /apps/{appID}
---

Retrieves an App object.
6 changes: 6 additions & 0 deletions api-reference/v2/apps/list-apps.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: List Apps
openapi: get /apps/{appID}
---

Returns a list of apps for your team.
6 changes: 6 additions & 0 deletions api-reference/v2/apps/transfer-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Transfer App
openapi: post /apps/{appID}/transfer
---

Transfer an App to a different Team.
6 changes: 6 additions & 0 deletions api-reference/v2/components/create-component.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Create Component
openapi: post /screens/{screenID}/components
---

Creates a Component for a Screen.
6 changes: 6 additions & 0 deletions api-reference/v2/components/get-component.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Get Component
openapi: get /screens/{screenID}/component/{componentID}
---

Retrieves a Component object.
6 changes: 6 additions & 0 deletions api-reference/v2/components/list-components.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: List Components
openapi: get /screens/{screenID}/components
---

Returns a list of the Components belonging to a Screen.
6 changes: 6 additions & 0 deletions api-reference/v2/components/update-component.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Update Component
openapi: put /screens/{screenID}/components/{componentID}
---

Update a Component for a Screen.
28 changes: 28 additions & 0 deletions api-reference/v2/computations/create-computation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Create Computation
openapi: post /computations
---

Create a new computation.

Tables can further reference computations in the column schema:

```json
"schema": {
"columns": [
{
"id": "invoiceDate",
"displayName": "Invoice Date",
"type": {
"kind": "computation",
"id": "abc123"
}
},
{
"id": "totalAmount",
"displayName": "Total",
"type": "number"
},
]
},
```
6 changes: 6 additions & 0 deletions api-reference/v2/screens/create-screen.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Create Screen
openapi: post /screens
---

Create a new Screen.
6 changes: 6 additions & 0 deletions api-reference/v2/screens/list-screens.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: List Screens
openapi: get /screens
---

Returns a list of the Screens.
6 changes: 6 additions & 0 deletions api-reference/v2/teams/get-team.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Get Team
openapi: get /teams/{teamID}
---

Retrieves a Team object.
6 changes: 6 additions & 0 deletions api-reference/v2/teams/list-teams.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: List Teams
openapi: get /teams
---

Retrieves a list of Teams that you belong to.
6 changes: 6 additions & 0 deletions api-reference/v2/workflows/get-workflows.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: List Workflows
openapi: get /workflows
---

Get a list of all Workflows.
52 changes: 48 additions & 4 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,45 @@
"api-reference/v2/general/errors"
]
},
{
"group": "Apps",
"pages": [
"api-reference/v2/apps/get-app",
"api-reference/v2/apps/list-apps",
"api-reference/v2/apps/create-app",
"api-reference/v2/apps/transfer-app"
]
},
{
"group": "Components",
"pages": [
"api-reference/v2/components/get-component",
"api-reference/v2/components/list-components",
"api-reference/v2/components/create-component",
"api-reference/v2/components/update-component"
]
},
{
"group": "Computations",
"pages": [
"api-reference/v2/computations/create-computation"
]
},
{
"group": "Screens",
"pages": [
"api-reference/v2/screens/list-screens",
"api-reference/v2/screens/create-screen"
]
},
{
"group": "Stashing",
"pages": [
"api-reference/v2/stashing/introduction",
"api-reference/v2/stashing/post-stashes-serial",
"api-reference/v2/stashing/delete-stash"
]
},
{
"group": "Tables",
"pages": [
Expand All @@ -40,11 +79,16 @@
]
},
{
"group": "Stashing",
"group": "Teams",
"pages": [
"api-reference/v2/stashing/introduction",
"api-reference/v2/stashing/post-stashes-serial",
"api-reference/v2/stashing/delete-stash"
"api-reference/v2/teams/get-team",
"api-reference/v2/teams/list-teams"
]
},
{
"group": "Workflows",
"pages": [
"api-reference/v2/workflows/get-workflows"
]
},
{
Expand Down