Skip to content

Commit 07c876c

Browse files
update Open Source Docs from Roblox internal teams
1 parent 4ba89b0 commit 07c876c

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

content/common/navigation/cloud/reference.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ navigation:
2020
path: /cloud/reference/openapi
2121
- title: Scopes
2222
path: /cloud/reference/scopes
23+
- title: Risk levels
24+
path: /cloud/reference/risk-levels
2325
- heading: Authentication
2426
- title: API keys
2527
path: /cloud/auth/api-keys
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Risk levels
3+
description: Explains the risk level classifications for Open Cloud API endpoints and their behavior in the "try it out" feature.
4+
---
5+
6+
Risk levels classify Open Cloud endpoints based on the potential impact of their operations. These classifications apply to the OAuth 2.0 authorization flow and the "try it out" feature here in the API documentation.
7+
8+
Risk levels help protect your data and account when testing API endpoints in the documentation. Always review an endpoint's functionality and potential impact before testing, particularly for medium and high risk operations that can modify your data.
9+
10+
## Try it out risk levels
11+
12+
The "try it out" feature uses four risk levels, which control the warnings and restrictions that you encounter when testing endpoints directly from the documentation.
13+
14+
<table>
15+
<thead>
16+
<tr>
17+
<th>Risk level</th>
18+
<th>"Try it out" allowed</th>
19+
<th>Warning dialog</th>
20+
<th>Warning banner</th>
21+
<th>Cookie attachment</th>
22+
</tr>
23+
</thead>
24+
<tbody>
25+
<tr>
26+
<td>Low</td>
27+
<td>&#9989;</td>
28+
<td>No</td>
29+
<td>Yes</td>
30+
<td>Yes</td>
31+
</tr>
32+
<tr>
33+
<td>Medium</td>
34+
<td>&#9989;</td>
35+
<td>Yes (per endpoint, per session)</td>
36+
<td>Yes</td>
37+
<td>Yes</td>
38+
</tr>
39+
<tr>
40+
<td>High</td>
41+
<td>&#9989;</td>
42+
<td>Yes (per endpoint, per session)</td>
43+
<td>Yes</td>
44+
<td>No</td>
45+
</tr>
46+
<tr>
47+
<td>Critical</td>
48+
<td>&#10060;</td>
49+
<td>N/A</td>
50+
<td>N/A</td>
51+
<td>N/A</td>
52+
</tr>
53+
</tbody>
54+
</table>
55+
56+
- **Low risk** endpoints primarily retrieve publicly available information and have minimal impact on your data or experiences. These endpoints show a simple informational banner when using "try it out."
57+
58+
- **Medium risk** endpoints can create, update, or access private information. Most changes you make from these endpoints can be reversed using other available endpoints. These endpoints have the following "try it out" safety measures:
59+
60+
- They display a confirmation dialog before you send a request. This dialog appears once per endpoint per browser session.
61+
- They show a warning banner to remind you of the risk level.
62+
63+
- **High risk** endpoints can modify or delete private information in ways that may be difficult or impossible to reverse. This category includes most DELETE operations and other potentially destructive actions. In addition to the confirmation dialog and warning banner from medium risk endpoints, cookie authentication is not supported for these endpoints.
64+
65+
- **Critical risk** endpoints access or modify highly sensitive data that could compromise account security or privacy. "Try it out" is disabled for these endpoints.

0 commit comments

Comments
 (0)