Skip to content

Commit 9d00654

Browse files
authored
Merge branch 'main' into main
2 parents 970a40e + d48f945 commit 9d00654

File tree

292 files changed

+3757
-1659
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

292 files changed

+3757
-1659
lines changed

content/common/navigation/cloud/reference.yaml

Lines changed: 322 additions & 336 deletions
Large diffs are not rendered by default.
Lines changed: 2 additions & 2 deletions
Loading

content/en-us/cloud/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ description: Get comprehensive API reference documentation for Open Cloud.
55

66
With Open Cloud, you can access Roblox resources through standard REST APIs, which lets you build everything from command line automation tools to complex web apps. The Open Cloud APIs support HTTPS and use [API keys](./auth/api-keys.md) or [OAuth 2.0](./auth/oauth2-overview.md) for authentication. You can update experiences, restart servers, work with your data stores and memory stores, manage user restrictions, list inventory items, and much, much more.
77

8-
## About the APIs
8+
## About this reference
99

10-
Roblox has four categories of HTTP REST API:
10+
This reference documentation is broken into two sections:
1111

12-
- Open Cloud v2
13-
- Open Cloud v1
14-
- [Legacy with API key and/or OAuth 2.0 authentication](legacy.md)
15-
- [Legacy with cookie authentication](legacy.md)
12+
- A [feature-based section](features/accounts.md) that categorizes APIs by use case (Avatars, Game Passes, Users, etc.).
13+
- A [section that separates endpoints by system](/cloud/reference/DataStore#List-Data-Stores) (Open Cloud v2, v1, or legacy).
1614

17-
Whenever possible, use Open Cloud v2, Open Cloud v1, or legacy endpoints that support API key and/or OAuth 2.0 authentication. These APIs have strong stability guarantees and regularly add new resources.
15+
**Both sections** contain the full list of available API endpoints; use whichever helps you find what you need.
1816

19-
Legacy API endpoints with cookie authentication can incorporate breaking changes without notice and have minimal stability guarantees. We don't recommend them for production applications.
17+
Whenever possible, use Open Cloud v2, Open Cloud v1, or [legacy endpoints that support API key and/or OAuth 2.0 authentication](legacy.md). These APIs have strong stability guarantees and regularly add new resources.
18+
19+
Legacy API endpoints with cookie authentication can incorporate breaking changes without notice and have minimal stability guarantees. We don't recommend them for production applications. The legacy API has been known by various names over the years, including the Roblox site API, the web API, and the classic API.
2020

2121
<Alert severity="info">
2222
Roblox also offers [webhooks](./webhooks/webhook-notifications.md), which can notify your applications when certain events occur, such as refunds or changes to subscriptions.

content/en-us/cloud/reference/patterns.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This page covers common patterns with the Open Cloud APIs, particularly around m
77

88
## Paths
99

10-
To make a request to the Open Cloud APIs, you must first form a URL. This URL is a combination of the base URL (`https://apis.roblox.com/cloud/v2`), the Open Cloud API path (for example, `/universes/{universe-id}/places/{place-id}/user-restrictions`), and any query parameters (for example, `?maxPageSize=25`). A full request URL might look like this:
10+
To make a request to the Open Cloud APIs, you must first form a URL. This URL is a combination of the base URL (`https://apis.roblox.com/cloud/v2`), the Open Cloud API path (for example, `/universes/{universe_id}/places/{place_id}/user-restrictions`), and any query parameters (for example, `?maxPageSize=25`). A full request URL might look like this:
1111

1212
```json
1313
https://apis.roblox.com/cloud/v2/users/4687549151/inventory-items?maxPageSize=100
@@ -17,8 +17,8 @@ Many paths, including the example above, have **path parameters**, designated by
1717

1818
Some resources have multiple path patterns, visible under the **Resource Paths** header in the API reference. For example, the URL for [List User Restrictions](/cloud/reference/UserRestriction#List-User-Restrictions) can be either of the following:
1919

20-
- `https://apis.roblox.com/cloud/cloud/v2/universes/{universe-id}/user-restrictions`
21-
- `https://apis.roblox.com/cloud/cloud/v2/universes/{universe-id}/places/{place-id}/user-restrictions`
20+
- `https://apis.roblox.com/cloud/cloud/v2/universes/{universe_id}/user-restrictions`
21+
- `https://apis.roblox.com/cloud/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions`
2222

2323
You can probably infer the difference between the two: some user restrictions apply to an entire universe (experience), whereas others apply to specific places within a universe. Aside from the small addition to the path and extra path parameter, the calls are identical.
2424

@@ -34,7 +34,7 @@ If you specify `maxPageSize` in your request, some methods return paginated
3434
results—essentially partial responses:
3535

3636
```json
37-
GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25
37+
GET /cloud/v2/users/{user_id}/inventory-items?maxPageSize=25
3838

3939
{
4040
"inventoryItems": [
@@ -44,12 +44,23 @@ GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25
4444
}
4545
```
4646

47+
```json
48+
GET /cloud/v2/universes/{universe_id}/data-stores?maxPageSize=25
49+
50+
{
51+
"dataStores": [
52+
...
53+
],
54+
"nextPageToken": "datastore1"
55+
}
56+
```
57+
4758
If a response includes a value for `nextPageToken`, use that value in the
4859
`pageToken` parameter of the subsequent request to retrieve the next page. When
49-
`nextPageToken` is empty, you've reached the end of your results:
60+
`nextPageToken` is empty or omitted entirely, you've reached the end of your results:
5061

5162
```json
52-
GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25&pageToken=aaaBBB
63+
GET /cloud/v2/users/{user_id}/inventory-items?maxPageSize=25&pageToken=aaaBBB
5364

5465
{
5566
"inventoryItems": [
@@ -59,6 +70,16 @@ GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25&pageToken=aaaBBB
5970
}
6071
```
6172

73+
```json
74+
GET /cloud/v2/universes/{universe_id}/data-stores?maxPageSize=25&pageToken=datastore1
75+
76+
{
77+
"dataStores": [
78+
...
79+
]
80+
}
81+
```
82+
6283
Aside from the `pageToken`, you must use the same query for pagination to work
6384
properly. Altering any filter parameter results in a 400 error.
6485

content/en-us/includes/studio/controller-emulator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: include
33
---
44

5-
The **Controller Emulator** lets you accurately emulate gamepad input directly in Studio. The default controller is a generic gamepad but you can select alternatives for PlayStation, Xbox, and Quest devices from the upper‑left picker menu.
5+
The **Controller Emulator** lets you accurately emulate gamepad input directly in Studio. The default controller is a generic gamepad, but you can select alternatives for PlayStation, Xbox, and Quest devices from the upper‑left picker menu.
66

77
<img src="../../assets/studio/general/Test-Tab-Emulation-Controllers.png" width="840" alt="Emulate Device Controllers button indicated in Test tab" />
88

content/en-us/includes/studio/device-emulator.md

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

5-
The **Device Emulator** lets you emulate various devices directly in Studio, providing insight on how controls operate on a mobile device or how [on-screen UI](../../ui/on-screen-containers.md) displays on different screens and aspect ratios.
5+
The **Device Emulator** lets you emulate various devices directly in Studio, providing insight into how controls work on mobile devices, consoles, and VR headsets, as well as how [on-screen UI](../../ui/on-screen-containers.md) elements display on different screen resolutions and aspect ratios.
66

77
<img src="../assets/studio/general/Test-Tab-Emulation-Device.png" width="800" alt="Device button indicated in Test tab" />
88

9-
In emulation mode, you can select devices from the **device selector** dropdown menu above the 3D viewport to emulate less powerful devices and test [streaming-enabled](../../workspace/streaming.md) experiences where 3D content dynamically loads/unloads based on available memory. You can also adjust the **view&nbsp;size** and change the **orientation** between landscape and portrait modes.
9+
In emulation mode, you can select devices from the **device selector** dropdown menu above the 3D viewport to emulate less powerful devices and test [streaming-enabled](../../workspace/streaming.md) experiences where 3D content dynamically loads and unloads based on available memory. You can also adjust the **view&nbsp;size** and change the **orientation** between landscape and portrait modes.
1010

1111
<img src="../assets/studio/general/Editor-Window-Emulation-Options.png" width="840" alt="Emulation options above the 3D viewport" />

content/en-us/input/gamepad.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,4 @@ end
280280

281281
## Controller emulation
282282

283-
<BetaAlert betaName="Gamepad Emulator" leadIn="This tool is currently in beta. Enable it through " leadOut="." components={props.components} />
284-
285283
<ControllerEmulator components={props.components} />

0 commit comments

Comments
 (0)