Skip to content

Commit 04dbe8e

Browse files
committed
caps page metadata
1 parent 0146f16 commit 04dbe8e

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

advanced/user-auth/overview.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ User Auth is an enterprise feature. {
6565
If you return API Playground inputs in the user info, they will automatically be prefilled in the API Playground. Make sure the name of the field in the user info is an exact match of the name in the API Playground.
6666
### Showing/Hiding Pages
6767
68-
By default, every page is visible to every user. If you want to restrict which pages are visible to your users, you can add a `groups` field in your page metadata.
68+
By default, every page is visible to every user. If you want to restrict which pages are visible to your users, you can add a `groups` field in your Page Metadata.
6969
When determining which pages to show to the user, Mintlify will check which groups the user belongs to.
70-
If the user is not in any of the groups listed in the page metadata, the page will not be shown.
70+
If the user is not in any of the groups listed in the Page Metadata, the page will not be shown.
7171
7272
```md
7373
---
@@ -77,12 +77,12 @@ groups: ['admin']
7777
---
7878
```
7979
80-
Here's a table that displays whether a page is shown for different combinations of `groups` in UserInfo and page metadata:
80+
Here's a table that displays whether a page is shown for different combinations of `groups` in UserInfo and Page Metadata:
8181
8282
| | `groups` not in UserInfo | `groups: []` in UserInfo | `groups: ['admin']` in UserInfo |
8383
|:-----------------------------------|:------------------------:|:-------------------------:|:--------------------------------:|
8484
| `groups` not in metadata | ✅ | ✅ | ✅ |
8585
| `groups: []` in metadata | ❌ | ❌ | ❌ |
8686
| `groups: ['admin']` in metadata | ❌ | ❌ | ✅ |
8787
88-
<Note>Note that an empty array in the page metadata is interpreted as "No groups should see this page."</Note>
88+
<Note>Note that an empty array in the Page Metadata is interpreted as "No groups should see this page."</Note>

api-playground/mdx/authentication.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The page's authentication method will override mint.json if both are set.
2121
}
2222
```
2323

24-
```md page metadata
24+
```md Page Metadata
2525
---
2626
title: "Your page title"
2727
authMethod: "bearer"
@@ -42,7 +42,7 @@ authMethod: "bearer"
4242
}
4343
```
4444

45-
```md page metadata
45+
```md Page Metadata
4646
---
4747
title: "Your page title"
4848
authMethod: "basic"
@@ -64,7 +64,7 @@ authMethod: "basic"
6464
}
6565
```
6666

67-
```md page metadata
67+
```md Page Metadata
6868
---
6969
title: "Your page title"
7070
authMethod: "key"
@@ -78,7 +78,7 @@ authMethod: "key"
7878
The "none" authentication method is useful to disable authentication on a specific endpoint after setting a default in mint.json.
7979

8080
<CodeGroup>
81-
```md page metadata
81+
```md Page Metadata
8282
---
8383
title: "Your page title"
8484
authMethod: "none"

api-playground/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here's a list of common issues we've seen customers run into:
2727
</Accordion>
2828

2929
<Accordion title="One of my OpenAPI pages is completely blank">
30-
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure
30+
This is usually caused by a misspelled `openapi` field in the Page Metadata. Make sure
3131
the HTTP method and path match the HTTP method and path in the OpenAPI document exactly.
3232

3333
Here's an example of how things might go wrong:

page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ description: "Setting the title and metadata for navigation and SEO"
4444
## API Pages
4545

4646
API pages let you build interactive API playgrounds. To create an API page, you
47-
must set an `api` or `openapi` property in the page metadata.
47+
must set an `api` or `openapi` property in the Page Metadata.
4848

4949
Learn more about API playgrounds in [our demo](/api-playground).
5050

settings/seo.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ title: 'Your Example Page Title'
4747

4848
<Warning>
4949

50-
Meta tags with colons need to be typed with quotes around them when you put them in the page metadata.
50+
Meta tags with colons need to be typed with quotes around them when you put them in the Page Metadata.
5151

5252
</Warning>
5353

settings/versioning.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Add `"versions": ["v2", "v1"]` to your `mint.json` file where `v1` and `v2` are
1919

2020
The best way to specify page versions is by adding a version value to a group in the navigation. When you specify the version of a group, that version is applied to all pages within that group.
2121

22-
You can also specify the version of a single page in the page metadata. Versions on individual pages always take precedence.
22+
You can also specify the version of a single page in the Page Metadata. Versions on individual pages always take precedence.
2323

2424
<CodeGroup>
2525
```json Groups (mint.json)

0 commit comments

Comments
 (0)