Skip to content

Commit da0b605

Browse files
authored
Replacing mint.json to docs.json (#506)
* Replacing mint.json to docs.json for everythin except versioning and navigation * Reflected docs.json for navigation and versioning
1 parent 61fe966 commit da0b605

32 files changed

+330
-272
lines changed

api-playground/mdx/authentication.mdx

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,20 @@ description: "You can set authentication parameters to let users use their real
55

66
## Enabling Authentication
77

8-
You can add an authentication method to your mint.json to enable it on every page or you can set it on a per-page basis.
8+
You can add an authentication method to your docs.json to enable it on every page or you can set it on a per-page basis.
99

10-
The page's authentication method will override mint.json if both are set.
10+
The page's authentication method will override docs.json if both are set.
1111

1212
### Bearer Token
1313

1414
<CodeGroup>
1515

16-
```json mint.json
16+
```json docs.json
1717
"api": {
18-
"auth": {
18+
"mdx": {
19+
"auth": {
1920
"method": "bearer"
21+
}
2022
}
2123
}
2224
```
@@ -34,10 +36,12 @@ authMethod: "bearer"
3436

3537
<CodeGroup>
3638

37-
```json mint.json
39+
```json docs.json
3840
"api": {
39-
"auth": {
41+
"mdx": {
42+
"auth": {
4043
"method": "basic"
44+
}
4145
}
4246
}
4347
```
@@ -55,11 +59,13 @@ authMethod: "basic"
5559

5660
<CodeGroup>
5761

58-
```json mint.json
62+
```json docs.json
5963
"api": {
60-
"auth": {
64+
"mdx": {
65+
"auth": {
6166
"method": "key",
6267
"name": "x-api-key"
68+
}
6369
}
6470
}
6571
```
@@ -75,7 +81,7 @@ authMethod: "key"
7581

7682
### None
7783

78-
The "none" authentication method is useful to disable authentication on a specific endpoint after setting a default in mint.json.
84+
The "none" authentication method is useful to disable authentication on a specific endpoint after setting a default in docs.json.
7985

8086
<CodeGroup>
8187
```md Page Metadata

api-playground/mdx/configuration.mdx

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,19 @@ title: 'MDX Setup'
33
description: 'Generate docs pages for your API endpoints using MDX'
44
---
55

6-
Mintlify allows you to define your API endpoints using a combination of `mint.json` configuration, MDX metadata fields, and the `<ParamFields />` component. From the defined endpoints, we generate an API playground, request examples, and response examples.
6+
Mintlify allows you to define your API endpoints using a combination of `docs.json` configuration, MDX metadata fields, and the `<ParamFields />` component. From the defined endpoints, we generate an API playground, request examples, and response examples.
77

88
<Steps>
99
<Step title="Configure your API">
10-
In your `mint.json` file, define your base URL and auth method:
10+
In your `docs.json` file, define your base URL and auth method:
1111

1212
```json
13-
{
14-
"api": {
15-
"baseUrl": "https://mintlify.com/api", // string array for multiple base URLs
13+
"api": {
14+
"mdx": {
15+
"server": "https://mintlify.com/api", // string array for multiple base URLs
1616
"auth": {
17-
"method": "bearer" // options: bearer, basic, key.
17+
"method": "key",
18+
"name": "x-api-key" // options: bearer, basic, key.
1819
}
1920
}
2021
}
@@ -23,16 +24,14 @@ Mintlify allows you to define your API endpoints using a combination of `mint.js
2324
If you would not like to show an API playground, you don't need to include auth types. Hide the playground with the following field:
2425

2526
```json
26-
{
27-
"api": {
28-
"playground": {
29-
"mode": "hide"
30-
}
27+
"api": {
28+
"playground": {
29+
"display": "none"
3130
}
3231
}
3332
```
3433

35-
Find a full list of API configurations [here](/settings/global#api-configurations).
34+
Find a full list of API configurations [here](/settings/global#param-api).
3635
</Step>
3736

3837
<Step title="Create your endpoint pages">
@@ -54,12 +53,12 @@ Mintlify allows you to define your API endpoints using a combination of `mint.js
5453

5554
<Note>
5655

57-
If you have `baseUrl` configured in [mint.json](/settings/global), you can use relative paths like `/v1/endpoint`.
56+
If you have `server` configured in [docs.json](/settings/global), you can use relative paths like `/v1/endpoint`.
5857

5958
</Note>
6059
</Step>
6160

6261
<Step title="Add your endpoints to your docs">
63-
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `mint.json`. Learn more about structuring your docs [here](/settings/navigation).
62+
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs [here](/settings/navigation).
6463
</Step>
6564
</Steps>

api-playground/openapi/setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ follow OpenAPI specification 3.0+.
1212

1313
## Auto-populate API pages
1414

15-
The fastest way to get started with OpenAPI is to add an `openapi` field to a tab or anchor in the `mint.json`. This field can contain either the path to an OpenAPI document in your docs repo, or the URL of a hosted OpenAPI document. Mintlify will automatically generate a page for each OpenAPI operation and place them in the tab/anchor.
15+
The fastest way to get started with OpenAPI is to add an `openapi` field to a tab or anchor in the `docs.json`. This field can contain either the path to an OpenAPI document in your docs repo, or the URL of a hosted OpenAPI document. Mintlify will automatically generate a page for each OpenAPI operation and place them in the tab/anchor.
1616

1717
**Example with Anchors:**
1818

api-playground/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ openapi: "v1 GET /users/{id}"
7676

7777
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure
7878
Mintlify to send requests directly to your backend with the `api.playground.disableProxy`
79-
setting in the `mint.json`, as described [here](/settings/global#api-configurations). This will
79+
setting in the `docs.json`, as described [here](/settings/global#api-configurations). This will
8080
likely require you to configure CORS on your server, as these requests will now come directly
8181
from your users' browsers.
8282

development.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ description: 'Preview changes locally to update your docs'
2727

2828
</CodeGroup>
2929

30-
**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command:
30+
**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command:
3131

3232
```bash
3333
mintlify dev

integrations/analytics/amplitude.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
title: "Amplitude"
33
---
44

5-
Add the following to your `mint.json` file to send analytics to Amplitude.
5+
Add the following to your `docs.json` file to send analytics to Amplitude.
66

77
<CodeGroup>
88

9-
```json Analytics options in mint.json
10-
"analytics": {
9+
```json Analytics options in docs.json
10+
"integrations": {
1111
"amplitude": {
1212
"apiKey": "required"
1313
}
1414
}
1515
```
1616

1717
```json Example
18-
"analytics": {
18+
"integrations": {
1919
"amplitude": {
2020
"apiKey": "76bb138bf3fbf58186XXX00000"
2121
}

integrations/analytics/clearbit.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
title: "Clearbit"
33
---
44

5-
Add the following to your `mint.json` file to send analytics to Clearbit.
5+
Add the following to your `docs.json` file to send analytics to Clearbit.
66

77
<CodeGroup>
88

9-
```json Analytics options in mint.json
10-
"analytics": {
9+
```json Analytics options in docs.json
10+
integrations: {
1111
"clearbit": {
1212
"publicApiKey": "required"
1313
}
1414
}
1515
```
1616

1717
```json Example
18-
"analytics": {
18+
integrations: {
1919
"clearbit": {
2020
"publicApiKey": "pk_1a1882"
2121
}

integrations/analytics/fathom.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
title: "Fathom"
33
---
44

5-
Add the following to your `mint.json` file to send analytics to Fathom.
5+
Add the following to your `docs.json` file to send analytics to Fathom.
66

77
You can get the `siteId` from your script settings.
88

99
<CodeGroup>
1010

11-
```json Analytics options in mint.json
12-
"analytics": {
11+
```json Analytics options in docs.json
12+
integrations: {
1313
"fathom": {
1414
"siteId": "required"
1515
}
1616
}
1717
```
1818

1919
```json Example
20-
"analytics": {
20+
integrations: {
2121
"fathom": {
2222
"siteId": "YSVMSDAY"
2323
}

integrations/analytics/google-analytics.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ Create a Web Stream and put the URL of your Mintlify docs site as the stream URL
2020

2121
Your Measurement ID looks like `G-XXXXXXX` and will show up under Stream Details immediately after you create the Web Stream.
2222

23-
### Put Measurement ID in mint.json
23+
### Put Measurement ID in docs.json
2424

25-
Add your Measurement ID to your `mint.json` file like so:
25+
Add your Measurement ID to your `docs.json` file like so:
2626

27-
```json mint.json
28-
"analytics": {
27+
```json docs.json
28+
integrations: {
2929
"ga4": {
3030
"measurementId": "G-XXXXXXX"
3131
}

integrations/analytics/google-tag-manager.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
title: "Google Tag Manager"
33
---
44

5-
Add your tag ID to `mint.json` file and we'll inject the Google Tag Manager script to all your pages.
5+
Add your tag ID to `docs.json` file and we'll inject the Google Tag Manager script to all your pages.
66

77
You are responsible for setting up cookie consent banners with Google Tag Manager if you need them.
88

99
<CodeGroup>
1010

11-
```json Analytics options in mint.json
12-
"analytics": {
11+
```json Analytics options in docs.json
12+
integrations: {
1313
"gtm": {
1414
"tagId": "required"
1515
}
1616
}
1717
```
1818

1919
```json Example
20-
"analytics": {
20+
integrations: {
2121
"gtm": {
2222
"tagId": "GTM-MGBL4PW"
2323
}

integrations/analytics/heap.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
title: "Heap"
33
---
44

5-
Add the following to your `mint.json` file to send analytics to Heap.
5+
Add the following to your `docs.json` file to send analytics to Heap.
66

77
<CodeGroup>
88

9-
```json Analytics options in mint.json
10-
"analytics": {
9+
```json Analytics options in docs.json
10+
integrations: {
1111
"heap": {
1212
"appId": "required"
1313
}
1414
}
1515
```
1616

1717
```json Example
18-
"analytics": {
18+
integrations: {
1919
"heap": {
2020
"appId": "1234567890"
2121
}

integrations/analytics/hotjar.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: "HotJar"
33
---
44

5-
Add the following to your `mint.json` file to send analytics to HotJar.
5+
Add the following to your `docs.json` file to send analytics to HotJar.
66

7-
```json Analytics options in mint.json
8-
"analytics": {
7+
```json Analytics options in docs.json
8+
integrations: {
99
"hotjar": {
1010
"hjid": "required",
1111
"hjsv": "required"

integrations/analytics/koala.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
title: "Koala"
33
---
44

5-
Add the following to your `mint.json` file to send analytics to Koala.
5+
Add the following to your `docs.json` file to send analytics to Koala.
66

77
<CodeGroup>
88

9-
```json Analytics options in mint.json
10-
"analytics": {
9+
```json Analytics options in docs.json
10+
integrations: {
1111
"koala": {
1212
"publicApiKey": "required"
1313
}
1414
}
1515
```
1616

1717
```json Example
18-
"analytics": {
18+
integrations: {
1919
"koala": {
2020
"publicApiKey": "pk_1a1882"
2121
}

integrations/analytics/logrocket.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: "LogRocket"
33
---
44

5-
Add the following to your `mint.json` file to send analytics to LogRocket.
5+
Add the following to your `docs.json` file to send analytics to LogRocket.
66

7-
```json Analytics options in mint.json
8-
"analytics": {
7+
```json Analytics options in docs.json
8+
integrations: {
99
"logrocket": {
1010
"apiKey": "required"
1111
}

integrations/analytics/mixpanel.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: "Mixpanel"
33
---
44

5-
Add the following to your `mint.json` file to send analytics to Mixpanel.
5+
Add the following to your `docs.json` file to send analytics to Mixpanel.
66

7-
```json Analytics options in mint.json
8-
"analytics": {
7+
```json Analytics options in docs.json
8+
integrations: {
99
"mixpanel": {
1010
"projectToken": "required"
1111
}

integrations/analytics/overview.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -506,14 +506,14 @@ className="h-6 w-6"
506506

507507
## Enabling Analytics
508508

509-
Set your analytics keys in `mint.json`. You can add an unlimited number of analytics integrations for free.
509+
Set your analytics keys in `docs.json`. You can add an unlimited number of analytics integrations for free.
510510

511-
The syntax for `mint.json` is below. You only need to include entries for the platforms you want to connect.
511+
The syntax for `docs.json` is below. You only need to include entries for the platforms you want to connect.
512512

513513
<CodeGroup>
514514

515-
```json Analytics options in mint.json
516-
"analytics": {
515+
```json Analytics options in docs.json
516+
integrations: {
517517
"amplitude": {
518518
"apiKey": "required"
519519
},
@@ -556,7 +556,7 @@ The syntax for `mint.json` is below. You only need to include entries for the pl
556556
```
557557

558558
```json Google Analytics 4 Example
559-
"analytics": {
559+
integrations: {
560560
"ga4": {
561561
"measurementId": "G-XXXXXXX"
562562
}

0 commit comments

Comments
 (0)