Skip to content

Commit 2d696ec

Browse files
jhutchings1jhutchings1
authored
Add cross-references to API reference docs (#22146)
* Add cross-references to API reference docs in fundamentals section * Update page title to rate limits
1 parent 89b8f8e commit 2d696ec

File tree

8 files changed

+153
-134
lines changed

8 files changed

+153
-134
lines changed

‎src/content/docs/fundamentals/api/reference/deprecations.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: API deprecations
44
release_notes_file_name:
55
- api-deprecations
66
sidebar:
7-
order: 5
7+
order: 6
88
---
99

1010
import { ProductReleaseNotes } from "~/components";

‎src/content/docs/fundamentals/api/reference/graphql-api.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
pcx_content_type: navigation
3+
title: GraphQL API
4+
external_link: /analytics/graphql-api/
5+
sidebar:
6+
order: 2
7+
---

‎src/content/docs/fundamentals/api/reference/limits.mdx‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
pcx_content_type: reference
3-
title: Limits
3+
title: Rate limits
44
sidebar:
5-
order: 2
6-
5+
order: 6
76
---
87

9-
import { Render } from "~/components"
8+
import { Render } from "~/components";
109

1110
<Render file="api-rate-limits" product="fundamentals" />

‎src/content/docs/fundamentals/api/reference/permissions.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: API token permissions
33
pcx_content_type: reference
44
sidebar:
5-
order: 3
5+
order: 5
66
---
77

88
import { Render, TabItem, Tabs } from "~/components";

‎src/content/docs/fundamentals/api/reference/rest-api.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
pcx_content_type: navigation
3+
title: REST API
4+
external_link: /api/
5+
sidebar:
6+
order: 1
7+
---

‎src/content/docs/fundamentals/api/reference/sdks.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
pcx_content_type: reference
33
title: SDKs
44
sidebar:
5-
order: 5
5+
order: 7
66
---
77

88
Cloudflare offers language software development kits (SDKs) as well as `curl` examples to demonstrate how to use the Cloudflare API. The SDK libraries allow you to interact with the Cloudflare API in language-specific syntax and more easily integrate with your existing applications.

‎src/content/docs/fundamentals/api/reference/template.mdx‎

Lines changed: 126 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -3,136 +3,135 @@ title: API token templates
33
pcx_content_type: reference
44
description: Explore Cloudflare's API token templates to efficiently manage permissions. Start with a template and customize token permissions and resources as needed.
55
sidebar:
6-
order: 4
7-
6+
order: 6
87
---
98

109
Below is a table of the currently available API token templates and the default [token permissions](/fundamentals/api/reference/permissions/) they grant. You can start creating a token with one of these templates and modify the permissions and resources from there.
1110

1211
<table>
13-
<tbody>
14-
<tr>
15-
<th>Template Name</th>
16-
<th>Permission</th>
17-
<th>Resource</th>
18-
</tr>
19-
<tr>
20-
<td>Edit Zone DNS</td>
21-
<td>DNS Write</td>
22-
<td>Zone</td>
23-
</tr>
24-
<tr>
25-
<td rowspan="2">Read billing info</td>
26-
<td>Billing Read</td>
27-
<td>Account</td>
28-
</tr>
29-
<tr>
30-
<td>Account resources: Include all accounts</td>
31-
<td></td>
32-
</tr>
33-
<tr>
34-
<td rowspan="2">Read analytics and logs</td>
35-
<td>Analytics Read</td>
36-
<td>Zone</td>
37-
</tr>
38-
<tr>
39-
<td>Logs Read</td>
40-
<td>Zone</td>
41-
</tr>
42-
<tr>
43-
<td rowspan="8">Edit Cloudflare Workers</td>
44-
<td>Workers Routes Write</td>
45-
<td>Zone</td>
46-
</tr>
47-
<tr>
48-
<td>Workers Scripts Write</td>
49-
<td>Account</td>
50-
</tr>
51-
<tr>
52-
<td>Workers KV Storage Write</td>
53-
<td>Account</td>
54-
</tr>
55-
<tr>
56-
<td>Workers Tail Read</td>
57-
<td>Account</td>
58-
</tr>
59-
<tr>
60-
<td>Workers R2 Storage Write</td>
61-
<td>Account</td>
62-
</tr>
63-
<tr>
64-
<td>Account Settings Read</td>
65-
<td>Account</td>
66-
</tr>
67-
<tr>
68-
<td>User Details Read</td>
69-
<td>User</td>
70-
</tr>
71-
<tr>
72-
<td>User Memberships Read</td>
73-
<td>User</td>
74-
</tr>
75-
<tr>
76-
<td rowspan="2">Edit load balancing configuration</td>
77-
<td>Load Balancing: Monitors and Pools Write</td>
78-
<td>Account</td>
79-
</tr>
80-
<tr>
81-
<td>Load Balancers Write</td>
82-
<td>Zone</td>
83-
</tr>
84-
<tr>
85-
<td rowspan="8">WordPress</td>
86-
<td>Analytics Read</td>
87-
<td>Zone</td>
88-
</tr>
89-
<tr>
90-
<td>Zone Read</td>
91-
<td>Zone</td>
92-
</tr>
93-
<tr>
94-
<td>Zone Settings Write</td>
95-
<td>Zone</td>
96-
</tr>
97-
<tr>
98-
<td>Account Settings Read</td>
99-
<td>Account</td>
100-
</tr>
101-
<tr>
102-
<td>DNS Read</td>
103-
<td>Zone</td>
104-
</tr>
105-
<tr>
106-
<td>Cache Purge</td>
107-
<td>Zone</td>
108-
</tr>
109-
<tr>
110-
<td>Account resources: Include all accounts</td>
111-
<td></td>
112-
</tr>
113-
<tr>
114-
<td>Zone resources: Include all zones</td>
115-
<td></td>
116-
</tr>
117-
<tr>
118-
<td>Create Additional Tokens</td>
119-
<td>API Tokens Write</td>
120-
<td>User</td>
121-
</tr>
122-
<tr>
123-
<td rowspan="3">Read All Resources</td>
124-
<td>
125-
<em>(All read permissions)</em>
126-
</td>
127-
<td>Account, Zone, User</td>
128-
</tr>
129-
<tr>
130-
<td>Account resources: Include all accounts</td>
131-
<td></td>
132-
</tr>
133-
<tr>
134-
<td>Zone resources: Include all zones</td>
135-
<td></td>
136-
</tr>
137-
</tbody>
12+
<tbody>
13+
<tr>
14+
<th>Template Name</th>
15+
<th>Permission</th>
16+
<th>Resource</th>
17+
</tr>
18+
<tr>
19+
<td>Edit Zone DNS</td>
20+
<td>DNS Write</td>
21+
<td>Zone</td>
22+
</tr>
23+
<tr>
24+
<td rowspan="2">Read billing info</td>
25+
<td>Billing Read</td>
26+
<td>Account</td>
27+
</tr>
28+
<tr>
29+
<td>Account resources: Include all accounts</td>
30+
<td></td>
31+
</tr>
32+
<tr>
33+
<td rowspan="2">Read analytics and logs</td>
34+
<td>Analytics Read</td>
35+
<td>Zone</td>
36+
</tr>
37+
<tr>
38+
<td>Logs Read</td>
39+
<td>Zone</td>
40+
</tr>
41+
<tr>
42+
<td rowspan="8">Edit Cloudflare Workers</td>
43+
<td>Workers Routes Write</td>
44+
<td>Zone</td>
45+
</tr>
46+
<tr>
47+
<td>Workers Scripts Write</td>
48+
<td>Account</td>
49+
</tr>
50+
<tr>
51+
<td>Workers KV Storage Write</td>
52+
<td>Account</td>
53+
</tr>
54+
<tr>
55+
<td>Workers Tail Read</td>
56+
<td>Account</td>
57+
</tr>
58+
<tr>
59+
<td>Workers R2 Storage Write</td>
60+
<td>Account</td>
61+
</tr>
62+
<tr>
63+
<td>Account Settings Read</td>
64+
<td>Account</td>
65+
</tr>
66+
<tr>
67+
<td>User Details Read</td>
68+
<td>User</td>
69+
</tr>
70+
<tr>
71+
<td>User Memberships Read</td>
72+
<td>User</td>
73+
</tr>
74+
<tr>
75+
<td rowspan="2">Edit load balancing configuration</td>
76+
<td>Load Balancing: Monitors and Pools Write</td>
77+
<td>Account</td>
78+
</tr>
79+
<tr>
80+
<td>Load Balancers Write</td>
81+
<td>Zone</td>
82+
</tr>
83+
<tr>
84+
<td rowspan="8">WordPress</td>
85+
<td>Analytics Read</td>
86+
<td>Zone</td>
87+
</tr>
88+
<tr>
89+
<td>Zone Read</td>
90+
<td>Zone</td>
91+
</tr>
92+
<tr>
93+
<td>Zone Settings Write</td>
94+
<td>Zone</td>
95+
</tr>
96+
<tr>
97+
<td>Account Settings Read</td>
98+
<td>Account</td>
99+
</tr>
100+
<tr>
101+
<td>DNS Read</td>
102+
<td>Zone</td>
103+
</tr>
104+
<tr>
105+
<td>Cache Purge</td>
106+
<td>Zone</td>
107+
</tr>
108+
<tr>
109+
<td>Account resources: Include all accounts</td>
110+
<td></td>
111+
</tr>
112+
<tr>
113+
<td>Zone resources: Include all zones</td>
114+
<td></td>
115+
</tr>
116+
<tr>
117+
<td>Create Additional Tokens</td>
118+
<td>API Tokens Write</td>
119+
<td>User</td>
120+
</tr>
121+
<tr>
122+
<td rowspan="3">Read All Resources</td>
123+
<td>
124+
<em>(All read permissions)</em>
125+
</td>
126+
<td>Account, Zone, User</td>
127+
</tr>
128+
<tr>
129+
<td>Account resources: Include all accounts</td>
130+
<td></td>
131+
</tr>
132+
<tr>
133+
<td>Zone resources: Include all zones</td>
134+
<td></td>
135+
</tr>
136+
</tbody>
138137
</table>

‎src/content/docs/fundamentals/api/reference/wrangler-api.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
pcx_content_type: navigation
3+
title: Wrangler API
4+
external_link: /workers/wrangler/api/
5+
sidebar:
6+
order: 3
7+
---

0 commit comments

Comments
 (0)