Initial commit

README.md

@@ -0,0 +1,34 @@
+# Mintlify Starter Kit
+
+Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
+
+- Guide pages
+- Navigation
+- Customizations
+- API Reference pages
+- Use of popular components
+
+### 👩‍💻 Development
+
+Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
+
+```
+npm i -g mintlify
+```
+
+Run the following command at the root of your documentation (where mint.json is)
+
+```
+mintlify dev
+```
+
+### 😎 Publishing Changes
+
+Changes will be deployed to production automatically after pushing to the default branch.
+
+You can also preview changes using PRs, which generates a preview link of the docs.
+
+#### Troubleshooting
+
+- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
+- Page loads as a 404 - Make sure you are running in a folder with `mint.json`

_snippets/snippet-example.mdx

@@ -0,0 +1,3 @@
+## My Snippet
+
+<Info>This is an example of a reusable snippet</Info>

api-reference/authentication.mdx

@@ -0,0 +1,22 @@
+---
+title: "Authentication"
+description: "Example overview page before API endpoints"
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas et eros iaculis tortor dapibus cursus. Curabitur quis sapien nec tortor dictum gravida.
+
+```bash
+'Authorization': 'Token <team_token>'
+```
+
+## API Tokens
+
+Nullam convallis mauris at nunc consectetur, ac imperdiet leo rutrum. Maecenas cursus purus a pellentesque blandit. Pellentesque vitae lacinia libero, non mollis metus.
+
+Nam id ullamcorper urna, at rutrum enim. [Maecenas vulputate](/introduction) vehicula libero, vitae sodales augue pretium nec. Quisque a magna tempor, semper risus vel, fermentum nunc. Pellentesque fermentum interdum ex, eu convallis massa blandit sed. Aliquam bibendum ipsum vel laoreet auctor.
+
+### Permissions
+
+Etiam lobortis ut odio ut fermentum. Nunc odio velit, sollicitudin at consectetur id, tristique eget turpis. Aliquam at risus vitae dolor sodales venenatis. In hac habitasse platea dictumst.
+
+Aenean consequat diam eget mollis fermentum. [Quisque eu malesuada](/introduction) felis, non dignissim libero.

api-reference/endpoint/create.mdx

@@ -0,0 +1,84 @@
+---
+title: "Create User"
+api: "POST https://api.mintlify.com/api/user"
+description: "This endpoint creates a new user"
+---
+
+### Body
+
+<ParamField body="current_token" type="string">
+ This is the current user group token you have for the user group that you want
+ to rotate.
+</ParamField>
+
+### Response
+
+<ResponseField name="success" type="number">
+ Indicates whether the call was successful. 1 if successful, 0 if not.
+</ResponseField>
+
+<ResponseField name="user_group" type="object">
+
+The contents of the user group
+
+<Expandable title="Toggle object">
+
+<ResponseField name="team_id" type="number">
+ This is the internal ID for this user group. You don't need to record this
+ information, since you will not need to use it.
+</ResponseField>
+
+<ResponseField name="token" type="string">
+ This is the user group token (userGroupToken or USER_GROUP_TOKEN) that will be
+ used to identify which user group is viewing the dashboard. You should save
+ this on your end to use when rendering an embedded dashboard.
+</ResponseField>
+
+<ResponseField name="name" type="string">
+ This is the name of the user group provided in the request body.
+</ResponseField>
+
+<ResponseField name="provided_id" type="string">
+ This is the user_group_id provided in the request body.
+</ResponseField>
+
+<ResponseField name="api_environment_tag" type="JSON or null">
+ This is the environment tag of the user group. Possible values are 'Customer'
+ and 'Testing'. User group id's must be unique to each environment, so you can
+ not create multiple user groups with with same id. If you have a production
+ customer and a test user group with the same id, you will be required to label
+ one as 'Customer' and another as 'Testing'
+</ResponseField>
+
+</Expandable>
+
+</ResponseField>
+
+<RequestExample>
+
+```bash Example Request
+curl --location --request POST 'https://api.mintlify.com/api/user' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Token <token>' \
+--data-raw '{
+ "current_token": ""
+}'
+```
+
+</RequestExample>
+
+<ResponseExample>
+
+```json Response
+{
+ "success": 1,
+ "user_group": {
+ "team_id": 3,
+ "token": "<user_group_token_to_auth_dashboard>",
+ "name": "Example 1",
+ "provided_id": "example_1"
+ }
+}
+```
+
+</ResponseExample>

api-reference/endpoint/delete.mdx

@@ -0,0 +1,47 @@
+---
+title: "Delete User"
+api: "DELETE https://api.mintlify.com/api/user"
+description: "This endpoint deletes an existing user."
+---
+
+### Body
+
+<ParamField body="data_source_provided_id" type="string">
+ The data source ID provided in the data tab may be used to identify the data
+ source for the user group
+</ParamField>
+
+<ParamField body="current_token" type="string">
+ This is the current user group token you have for the user group you want to
+ delete
+</ParamField>
+
+### Response
+
+<ResponseField name="success" type="number">
+ Indicates whether the call was successful. 1 if successful, 0 if not.
+</ResponseField>
+
+<RequestExample>
+
+```bash Example Request
+curl --location --request DELETE 'https://api.mintlify.com/api/user' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Token <token>' \
+--data-raw '{
+ "user_group_id": "example_1"
+ "current_token": "abcdef"
+}'
+```
+
+</RequestExample>
+
+<ResponseExample>
+
+```json Response
+{
+ "success": 1
+}
+```
+
+</ResponseExample>

api-reference/endpoint/get.mdx

@@ -0,0 +1,101 @@
+---
+title: "Get User"
+api: "GET https://api.mintlify.com/api/user"
+description: "This endpoint gets or creates a new user."
+---
+
+### Body
+
+<ParamField body="name" type="string">
+ This is the name of the user group.
+</ParamField>
+
+<ParamField body="user_group_id" type="string">
+ This is the ID you use to identify this user group in your database.
+</ParamField>
+
+<ParamField body="mapping" type="object">
+ This is a JSON mapping of schema id to either the data source that this user group should be
+ associated with or id of the datasource you provided when creating it.
+</ParamField>
+
+<ParamField body="properties" type="object">
+ This is a JSON object for properties assigned to this user group. These will be accessible through
+ variables in the dashboards and SQL editor
+</ParamField>
+
+### Response
+
+<ResponseField name="success" type="number">
+ Indicates whether the call was successful. 1 if successful, 0 if not.
+</ResponseField>
+
+<ResponseField name="new_user_group" type="boolean">
+ Indicates whether a new user group was created.
+</ResponseField>
+
+<ResponseField name="user_group" type="object">
+
+The contents of the user group
+
+<Expandable title="Toggle object">
+
+<ResponseField name="team_id" type="number">
+ This is the internal ID for this user group. You don't need to record this information, since
+ you will not need to use it.
+</ResponseField>
+
+<ResponseField name="token" type="string">
+ This is the user group token (userGroupToken or USER_GROUP_TOKEN) that will be used to identify
+ which user group is viewing the dashboard. You should save this on your end to use when rendering
+ an embedded dashboard.
+</ResponseField>
+
+<ResponseField name="name" type="string">
+ This is the name of the user group provided in the request body.
+</ResponseField>
+
+<ResponseField name="provided_id" type="string">
+ This is the user_group_id provided in the request body.
+</ResponseField>
+
+<ResponseField name="properties" type="JSON or null">
+ This is the properties object if it was provided in the request body
+</ResponseField>
+
+</Expandable>
+
+</ResponseField>
+
+<RequestExample>
+
+```bash Example Request
+curl --location --request GET 'https://api.mintlify.com/api/user' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Token <token>' \
+--data-raw '{
+ "user_group_id": "example_1",
+ "name": "Example 1",
+ "mapping": {"40": "213", "134": "386"},
+ "properties": {"filterValue": "value"}
+}'
+```
+
+</RequestExample>
+
+<ResponseExample>
+
+```json Response
+{
+ "success": 1,
+ "new_user_group": true,
+ "user_group": {
+ "team_id": 3,
+ "token": "<user_group_token_to_auth_dashboard>",
+ "name": "Example 1",
+ "provided_id": "example_1"
+ }
+}
+```
+
+</ResponseExample>

api-reference/endpoint/update.mdx

@@ -0,0 +1,101 @@
+---
+title: "Update User"
+api: "PUT https://api.mintlify.com/api/user"
+description: "This endpoint updates an existing user."
+---
+
+### Body
+
+<ParamField body="name" type="string">
+ This is the name of the user group.
+</ParamField>
+
+<ParamField body="user_group_id" type="string">
+ This is the ID you use to identify this user group in your database.
+</ParamField>
+
+<ParamField body="mapping" type="object">
+ This is a JSON mapping of schema id to either the data source that this user
+ group should be associated with or id of the datasource you provided when
+ creating it.
+</ParamField>
+
+<ParamField body="properties" type="object">
+ This is a JSON object for properties assigned to this user group. These will
+ be accessible through variables in the dashboards and SQL editor
+</ParamField>
+
+### Response
+
+<ResponseField name="success" type="number">
+ Indicates whether the call was successful. 1 if successful, 0 if not.
+</ResponseField>
+
+<ResponseField name="user_group" type="object">
+
+The contents of the user group
+
+<Expandable title="Toggle object">
+
+<ResponseField name="team_id" type="number">
+ Indicates whether a new user group was created.
+</ResponseField>
+
+<ResponseField name="token" type="string">
+ This is the user group token (userGroupToken or USER_GROUP_TOKEN) that will be
+ used to identify which user group is viewing the dashboard. You should save
+ this on your end to use when rendering an embedded dashboard.
+</ResponseField>
+
+<ResponseField name="name" type="string">
+ This is the name of the user group provided in the request body.
+</ResponseField>
+
+<ResponseField name="provided_id" type="string">
+ This is the user_group_id provided in the request body.
+</ResponseField>
+
+<ResponseField name="properties" type="JSON | Null">
+ This is the properties object if it was provided in the request body
+</ResponseField>
+
+<ResponseField name="api_environment_tag" type="JSON or null">
+ This is the environment tag of the user group. Possible values are 'Customer'
+ and 'Testing'
+</ResponseField>
+
+</Expandable>
+
+</ResponseField>
+
+<RequestExample>
+
+```bash Example Request
+curl --location --request PUT 'https://api.mintlify.com/api/user' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Token <token>' \
+--data-raw '{
+ "user_group_id": "example_1",
+ "name": "Example 1",
+ "mapping": {"40": "213", "134": "386"},
+ "properties": {"filterValue": "value"}
+}'
+```
+
+</RequestExample>
+
+<ResponseExample>
+
+```json Response
+{
+ "success": 1,
+ "user_group": {
+ "team_id": 113,
+ "token": "<user_group_token_to_auth_dashboard>",
+ "name": "ok",
+ "provided_id": "6"
+ }
+}
+```
+
+</ResponseExample>