From b614042cddb9c9103e7bb41a1078af5bf1279bf4 Mon Sep 17 00:00:00 2001 From: Shay Frendt Date: Tue, 13 Aug 2024 14:42:03 -0400 Subject: [PATCH 1/4] Add a bunch of exploratory endpoints --- .nvmrc | 1 + api-reference/v2/apps/get-app.mdx | 6 +++ api-reference/v2/apps/list-apps.mdx | 6 +++ api-reference/v2/apps/transfer-app.mdx | 6 +++ .../v2/components/create-component.mdx | 6 +++ api-reference/v2/components/get-component.mdx | 6 +++ .../v2/components/list-components.mdx | 6 +++ .../v2/components/update-component.mdx | 6 +++ api-reference/v2/screens/create-screen.mdx | 6 +++ api-reference/v2/screens/list-screens.mdx | 6 +++ api-reference/v2/teams/get-team.mdx | 6 +++ api-reference/v2/teams/list-teams.mdx | 6 +++ api-reference/v2/workflows/get-workflows.mdx | 6 +++ mint.json | 45 +++++++++++++++++-- 14 files changed, 114 insertions(+), 4 deletions(-) create mode 100644 .nvmrc create mode 100644 api-reference/v2/apps/get-app.mdx create mode 100644 api-reference/v2/apps/list-apps.mdx create mode 100644 api-reference/v2/apps/transfer-app.mdx create mode 100644 api-reference/v2/components/create-component.mdx create mode 100644 api-reference/v2/components/get-component.mdx create mode 100644 api-reference/v2/components/list-components.mdx create mode 100644 api-reference/v2/components/update-component.mdx create mode 100644 api-reference/v2/screens/create-screen.mdx create mode 100644 api-reference/v2/screens/list-screens.mdx create mode 100644 api-reference/v2/teams/get-team.mdx create mode 100644 api-reference/v2/teams/list-teams.mdx create mode 100644 api-reference/v2/workflows/get-workflows.mdx diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..7ea6a59 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +v20.11.0 diff --git a/api-reference/v2/apps/get-app.mdx b/api-reference/v2/apps/get-app.mdx new file mode 100644 index 0000000..0abd0bc --- /dev/null +++ b/api-reference/v2/apps/get-app.mdx @@ -0,0 +1,6 @@ +--- +title: Get App +openapi: get /apps/{appID} +--- + +Retrieves an App object. \ No newline at end of file diff --git a/api-reference/v2/apps/list-apps.mdx b/api-reference/v2/apps/list-apps.mdx new file mode 100644 index 0000000..b319472 --- /dev/null +++ b/api-reference/v2/apps/list-apps.mdx @@ -0,0 +1,6 @@ +--- +title: List Apps +openapi: get /apps/{appID} +--- + +Returns a list of apps for your team. \ No newline at end of file diff --git a/api-reference/v2/apps/transfer-app.mdx b/api-reference/v2/apps/transfer-app.mdx new file mode 100644 index 0000000..5dcbfa3 --- /dev/null +++ b/api-reference/v2/apps/transfer-app.mdx @@ -0,0 +1,6 @@ +--- +title: Transfer App +openapi: post /apps/{appID}/transfer +--- + +Transfer an App to a different Team. \ No newline at end of file diff --git a/api-reference/v2/components/create-component.mdx b/api-reference/v2/components/create-component.mdx new file mode 100644 index 0000000..77dfc9d --- /dev/null +++ b/api-reference/v2/components/create-component.mdx @@ -0,0 +1,6 @@ +--- +title: Create Component +openapi: post /app/{appID}/screens/{screenID}/components +--- + +Creates a Component for a Screen in an App. \ No newline at end of file diff --git a/api-reference/v2/components/get-component.mdx b/api-reference/v2/components/get-component.mdx new file mode 100644 index 0000000..ff9c6c3 --- /dev/null +++ b/api-reference/v2/components/get-component.mdx @@ -0,0 +1,6 @@ +--- +title: Get Component +openapi: get /app/{appID}/screens/{screenID}/component/{componentID} +--- + +Retrieves a Component object. \ No newline at end of file diff --git a/api-reference/v2/components/list-components.mdx b/api-reference/v2/components/list-components.mdx new file mode 100644 index 0000000..8284973 --- /dev/null +++ b/api-reference/v2/components/list-components.mdx @@ -0,0 +1,6 @@ +--- +title: List Components +openapi: get /apps/{appID}/screens/{screenID}/components +--- + +Returns a list of the Components belonging to a Screen in an App. \ No newline at end of file diff --git a/api-reference/v2/components/update-component.mdx b/api-reference/v2/components/update-component.mdx new file mode 100644 index 0000000..14d0962 --- /dev/null +++ b/api-reference/v2/components/update-component.mdx @@ -0,0 +1,6 @@ +--- +title: Update Component +openapi: put /app/{appID}/screens/{screenID}/components/{componentID} +--- + +Update a Component for a Screen in an App. \ No newline at end of file diff --git a/api-reference/v2/screens/create-screen.mdx b/api-reference/v2/screens/create-screen.mdx new file mode 100644 index 0000000..186c3f1 --- /dev/null +++ b/api-reference/v2/screens/create-screen.mdx @@ -0,0 +1,6 @@ +--- +title: Create Screen +openapi: post /app/{appID}/screens +--- + +Create a new Screen for an App. \ No newline at end of file diff --git a/api-reference/v2/screens/list-screens.mdx b/api-reference/v2/screens/list-screens.mdx new file mode 100644 index 0000000..9e3ae2c --- /dev/null +++ b/api-reference/v2/screens/list-screens.mdx @@ -0,0 +1,6 @@ +--- +title: List Screens +openapi: get /apps/{appID}/screens +--- + +Returns a list of the Screens belonging to an App. \ No newline at end of file diff --git a/api-reference/v2/teams/get-team.mdx b/api-reference/v2/teams/get-team.mdx new file mode 100644 index 0000000..260dfd9 --- /dev/null +++ b/api-reference/v2/teams/get-team.mdx @@ -0,0 +1,6 @@ +--- +title: Get Team +openapi: get /teams/{teamID} +--- + +Retrieves a Team object. \ No newline at end of file diff --git a/api-reference/v2/teams/list-teams.mdx b/api-reference/v2/teams/list-teams.mdx new file mode 100644 index 0000000..9f54be3 --- /dev/null +++ b/api-reference/v2/teams/list-teams.mdx @@ -0,0 +1,6 @@ +--- +title: List Teams +openapi: get /teams +--- + +Retrieves a list of Teams that you belong to. \ No newline at end of file diff --git a/api-reference/v2/workflows/get-workflows.mdx b/api-reference/v2/workflows/get-workflows.mdx new file mode 100644 index 0000000..ae91034 --- /dev/null +++ b/api-reference/v2/workflows/get-workflows.mdx @@ -0,0 +1,6 @@ +--- +title: List Workflows +openapi: get /apps/{appID}/workflows +--- + +Get a list of all Workflows associated with an App. \ No newline at end of file diff --git a/mint.json b/mint.json index a4f245c..88f0ac0 100644 --- a/mint.json +++ b/mint.json @@ -30,6 +30,38 @@ "api-reference/v2/general/errors" ] }, + { + "group": "Apps", + "pages": [ + "api-reference/v2/apps/get-app", + "api-reference/v2/apps/list-apps", + "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": "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": [ @@ -40,11 +72,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" ] }, { From 037cd30c8cff60fd2b062349a378878c8f3540bb Mon Sep 17 00:00:00 2001 From: Shay Frendt Date: Tue, 13 Aug 2024 14:46:18 -0400 Subject: [PATCH 2/4] Add create an app --- api-reference/v2/apps/create-app.mdx | 6 ++++++ mint.json | 1 + 2 files changed, 7 insertions(+) create mode 100644 api-reference/v2/apps/create-app.mdx diff --git a/api-reference/v2/apps/create-app.mdx b/api-reference/v2/apps/create-app.mdx new file mode 100644 index 0000000..fedc18b --- /dev/null +++ b/api-reference/v2/apps/create-app.mdx @@ -0,0 +1,6 @@ +--- +title: Create App +openapi: post /apps +--- + +Creates a new App. \ No newline at end of file diff --git a/mint.json b/mint.json index 88f0ac0..c65f101 100644 --- a/mint.json +++ b/mint.json @@ -35,6 +35,7 @@ "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" ] }, From fe67c1203c11a3c3c143be33a4a05fd9330a7515 Mon Sep 17 00:00:00 2001 From: Shay Frendt Date: Tue, 20 Aug 2024 11:16:38 -0400 Subject: [PATCH 3/4] Decouple screens from apps --- .../v2/components/create-component.mdx | 4 +-- api-reference/v2/components/get-component.mdx | 2 +- .../v2/components/list-components.mdx | 4 +-- .../v2/components/update-component.mdx | 4 +-- .../v2/computations/create-computation.mdx | 26 +++++++++++++++++++ api-reference/v2/screens/create-screen.mdx | 4 +-- api-reference/v2/screens/list-screens.mdx | 4 +-- api-reference/v2/workflows/get-workflows.mdx | 4 +-- mint.json | 6 +++++ 9 files changed, 45 insertions(+), 13 deletions(-) create mode 100644 api-reference/v2/computations/create-computation.mdx diff --git a/api-reference/v2/components/create-component.mdx b/api-reference/v2/components/create-component.mdx index 77dfc9d..56e1e1b 100644 --- a/api-reference/v2/components/create-component.mdx +++ b/api-reference/v2/components/create-component.mdx @@ -1,6 +1,6 @@ --- title: Create Component -openapi: post /app/{appID}/screens/{screenID}/components +openapi: post /screens/{screenID}/components --- -Creates a Component for a Screen in an App. \ No newline at end of file +Creates a Component for a Screen. \ No newline at end of file diff --git a/api-reference/v2/components/get-component.mdx b/api-reference/v2/components/get-component.mdx index ff9c6c3..b88a27b 100644 --- a/api-reference/v2/components/get-component.mdx +++ b/api-reference/v2/components/get-component.mdx @@ -1,6 +1,6 @@ --- title: Get Component -openapi: get /app/{appID}/screens/{screenID}/component/{componentID} +openapi: get /screens/{screenID}/component/{componentID} --- Retrieves a Component object. \ No newline at end of file diff --git a/api-reference/v2/components/list-components.mdx b/api-reference/v2/components/list-components.mdx index 8284973..b9eeb16 100644 --- a/api-reference/v2/components/list-components.mdx +++ b/api-reference/v2/components/list-components.mdx @@ -1,6 +1,6 @@ --- title: List Components -openapi: get /apps/{appID}/screens/{screenID}/components +openapi: get /screens/{screenID}/components --- -Returns a list of the Components belonging to a Screen in an App. \ No newline at end of file +Returns a list of the Components belonging to a Screen. \ No newline at end of file diff --git a/api-reference/v2/components/update-component.mdx b/api-reference/v2/components/update-component.mdx index 14d0962..4b9da61 100644 --- a/api-reference/v2/components/update-component.mdx +++ b/api-reference/v2/components/update-component.mdx @@ -1,6 +1,6 @@ --- title: Update Component -openapi: put /app/{appID}/screens/{screenID}/components/{componentID} +openapi: put /screens/{screenID}/components/{componentID} --- -Update a Component for a Screen in an App. \ No newline at end of file +Update a Component for a Screen. \ No newline at end of file diff --git a/api-reference/v2/computations/create-computation.mdx b/api-reference/v2/computations/create-computation.mdx new file mode 100644 index 0000000..4679352 --- /dev/null +++ b/api-reference/v2/computations/create-computation.mdx @@ -0,0 +1,26 @@ +--- +title: Create Computation +openapi: post /computations +--- + +Create a new computation. + +```json + "schema": { + "columns": [ + { + "id": "invoiceDate", + "displayName": "Invoice Date", + "type": { + "kind": "computation", + "id": "abc123" + } + }, + { + "id": "totalAmount", + "displayName": "Total", + "type": "number" + }, + ] + }, +``` \ No newline at end of file diff --git a/api-reference/v2/screens/create-screen.mdx b/api-reference/v2/screens/create-screen.mdx index 186c3f1..e28b941 100644 --- a/api-reference/v2/screens/create-screen.mdx +++ b/api-reference/v2/screens/create-screen.mdx @@ -1,6 +1,6 @@ --- title: Create Screen -openapi: post /app/{appID}/screens +openapi: post /screens --- -Create a new Screen for an App. \ No newline at end of file +Create a new Screen. \ No newline at end of file diff --git a/api-reference/v2/screens/list-screens.mdx b/api-reference/v2/screens/list-screens.mdx index 9e3ae2c..a1cbb64 100644 --- a/api-reference/v2/screens/list-screens.mdx +++ b/api-reference/v2/screens/list-screens.mdx @@ -1,6 +1,6 @@ --- title: List Screens -openapi: get /apps/{appID}/screens +openapi: get /screens --- -Returns a list of the Screens belonging to an App. \ No newline at end of file +Returns a list of the Screens. \ No newline at end of file diff --git a/api-reference/v2/workflows/get-workflows.mdx b/api-reference/v2/workflows/get-workflows.mdx index ae91034..4fd1fb3 100644 --- a/api-reference/v2/workflows/get-workflows.mdx +++ b/api-reference/v2/workflows/get-workflows.mdx @@ -1,6 +1,6 @@ --- title: List Workflows -openapi: get /apps/{appID}/workflows +openapi: get /workflows --- -Get a list of all Workflows associated with an App. \ No newline at end of file +Get a list of all Workflows. \ No newline at end of file diff --git a/mint.json b/mint.json index c65f101..d60a51b 100644 --- a/mint.json +++ b/mint.json @@ -48,6 +48,12 @@ "api-reference/v2/components/update-component" ] }, + { + "group": "Computations", + "pages": [ + "api-reference/v2/computations/create-computation" + ] + }, { "group": "Screens", "pages": [ From 4c8bee1fbd666bd0ff9a02717d67db67ff139a86 Mon Sep 17 00:00:00 2001 From: Shay Frendt Date: Tue, 20 Aug 2024 11:18:51 -0400 Subject: [PATCH 4/4] Add context about computations --- api-reference/v2/computations/create-computation.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/v2/computations/create-computation.mdx b/api-reference/v2/computations/create-computation.mdx index 4679352..102c10f 100644 --- a/api-reference/v2/computations/create-computation.mdx +++ b/api-reference/v2/computations/create-computation.mdx @@ -5,6 +5,8 @@ openapi: post /computations Create a new computation. +Tables can further reference computations in the column schema: + ```json "schema": { "columns": [