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/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/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..56e1e1b --- /dev/null +++ b/api-reference/v2/components/create-component.mdx @@ -0,0 +1,6 @@ +--- +title: Create Component +openapi: post /screens/{screenID}/components +--- + +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 new file mode 100644 index 0000000..b88a27b --- /dev/null +++ b/api-reference/v2/components/get-component.mdx @@ -0,0 +1,6 @@ +--- +title: Get Component +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 new file mode 100644 index 0000000..b9eeb16 --- /dev/null +++ b/api-reference/v2/components/list-components.mdx @@ -0,0 +1,6 @@ +--- +title: List Components +openapi: get /screens/{screenID}/components +--- + +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 new file mode 100644 index 0000000..4b9da61 --- /dev/null +++ b/api-reference/v2/components/update-component.mdx @@ -0,0 +1,6 @@ +--- +title: Update Component +openapi: put /screens/{screenID}/components/{componentID} +--- + +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..102c10f --- /dev/null +++ b/api-reference/v2/computations/create-computation.mdx @@ -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" + }, + ] + }, +``` \ 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..e28b941 --- /dev/null +++ b/api-reference/v2/screens/create-screen.mdx @@ -0,0 +1,6 @@ +--- +title: Create Screen +openapi: post /screens +--- + +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 new file mode 100644 index 0000000..a1cbb64 --- /dev/null +++ b/api-reference/v2/screens/list-screens.mdx @@ -0,0 +1,6 @@ +--- +title: List Screens +openapi: get /screens +--- + +Returns a list of the Screens. \ 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..4fd1fb3 --- /dev/null +++ b/api-reference/v2/workflows/get-workflows.mdx @@ -0,0 +1,6 @@ +--- +title: List Workflows +openapi: get /workflows +--- + +Get a list of all Workflows. \ No newline at end of file diff --git a/mint.json b/mint.json index a4f245c..d60a51b 100644 --- a/mint.json +++ b/mint.json @@ -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": [ @@ -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" ] }, {