Skip to content

Commit 90f2142

Browse files
update Open Source Docs from Roblox internal teams
1 parent 8cb3dbe commit 90f2142

File tree

9 files changed

+296
-127
lines changed

9 files changed

+296
-127
lines changed

content/en-us/cloud-services/data-stores/versioning-listing-and-caching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ end
8888

8989
### Snapshots
9090

91-
The [Snapshot Data Stores Open Cloud API](/cloud/reference/DataStore#Snapshot-Data-Stores) lets you take a snapshot of all data stores in an experience once a day. Before you publish any experience update that changes your data storage logic, make sure to take a snapshot. Taking a snapshot guarantees that you have the most recent data available from the previous version of the experience.
91+
The [Snapshot Data Stores Open Cloud API](/cloud/reference/DataStore#Cloud_SnapshotDataStores) lets you take a snapshot of all data stores in an experience once a day. Before you publish any experience update that changes your data storage logic, make sure to take a snapshot. Taking a snapshot guarantees that you have the most recent data available from the previous version of the experience.
9292

9393
For example, without a snapshot, if you publish an update at 3:30 UTC that causes data corruption, the corrupted data overwrites any data written between 3:00-3:30 UTC. If you take a snapshot at 3:29 UTC, though, the corrupted data doesn't overwrite anything written before 3:29 UTC, and the latest data for all keys written between 3:00-3:29 UTC is preserved.
9494

content/en-us/cloud/auth/api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To create an API key:
4141
1. From the **Experience Operations** dropdown, select the operations that you
4242
want to enable for the API key.
4343

44-
Many operations in the [API reference](../index.md) include the required permission scopes. For example, the [flush memory store](/cloud/reference/MemoryStore#Flush-Memory-Store) operation requires the `universe.memory-store:flush` permission.
44+
Many operations in the [API reference](../index.md) include the required permission scopes. For example, the [flush memory store](/cloud/reference/MemoryStore#Cloud_FlushMemoryStore) operation requires the `universe.memory-store:flush` permission.
4545

4646
<Alert severity="warning">
4747
For security reasons, give each API key the minimum number of required permissions. If an API key leaks, this principle of least privilege ensures that only a subset of your resources are compromised.

content/en-us/cloud/guides/instance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ These APIs are currently in beta and have the following restrictions:
2525

2626
- You must have a [collaborative](../../projects/collaboration.md) session enabled for the experience that you want to access.
2727

28-
- Request bodies, such as to [Update Instance](/cloud/reference/Instance#Update-Instance), are limited to 200 KB.
28+
- Request bodies, such as to [Update Instance](/cloud/reference/Instance#Cloud_UpdateInstance), are limited to 200 KB.
2929

3030
## List children
3131

3232
List all children of a specific instance by specifying an instance ID and
33-
calling the [List Instance Children](/cloud/reference/Instance#List-Instance-Children)
33+
calling the [List Instance Children](/cloud/reference/Instance#Cloud_ListInstanceChildren)
3434
method.
3535

3636
<Alert severity="info">

content/en-us/cloud/guides/usage-messaging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Messaging usage guide
33
description: Explains how to use Open Cloud Messaging Service API to support cross-server messaging.
44
---
55

6-
The [Messaging Service API](/cloud/reference/Universe#Publish-Universe-Message) is the Open Cloud equivalent of the Engine `Class.MessagingService`, which lets you communicate across your experience's servers and clients. The Engine API only allows you to write and update scripts manually in Studio for publishing messages, but the Open Cloud API lets you send messages to live servers from external tools to automate and improve your operations workflows.
6+
The [Messaging Service API](/cloud/reference/Universe#Cloud_PublishUniverseMessage) is the Open Cloud equivalent of the Engine `Class.MessagingService`, which lets you communicate across your experience's servers and clients. The Engine API only allows you to write and update scripts manually in Studio for publishing messages, but the Open Cloud API lets you send messages to live servers from external tools to automate and improve your operations workflows.
77

88
## Usage
99

content/en-us/cloud/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ With Open Cloud, you can access Roblox resources through standard [REST](https:/
1010
This reference documentation is broken into two sections:
1111

1212
- 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).
13+
- A [section that separates endpoints by system](/cloud/reference/DataStore#Cloud_ListDataStores) (Open Cloud v2, v1, or legacy).
1414

1515
**Both sections** contain the full list of available API endpoints; use whichever helps you find what you need.
1616

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ https://apis.roblox.com/cloud/v2/users/4687549151/inventory-items?maxPageSize=10
1515

1616
Many paths, including the example above, have **path parameters**, designated by curly brackets in the API reference. Path parameters are just variables that you insert before making the request and are almost always IDs: user IDs, group IDs, place IDs, etc. IDs are often numeric, but not necessarily; for example, data store and memory store IDs support a wider character set.
1717

18-
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:
18+
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#Cloud_ListUserRestrictions__Using_Universes) can be either of the following:
1919

2020
- `https://apis.roblox.com/cloud/cloud/v2/universes/{universe_id}/user-restrictions`
2121
- `https://apis.roblox.com/cloud/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions`

content/en-us/projects/external-tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ You might also consider adding:
153153
- A linter like [selene](https://github.com/Kampfkarren/selene) to catch common issues and enforce coding standards
154154
- A code formatter like [StyLua](https://github.com/JohnnyMorganz/StyLua)
155155
- A language server like [Luau Language Server](https://github.com/JohnnyMorganz/luau-lsp) for autocompletion, type checking, and more
156-
- [Open Cloud](../cloud/guides/index.md) scripts (not synced to Studio) to [update a published experience](/cloud/reference/Universe#Update-Universe) or [restart servers](/cloud/reference/Universe#Restart-Universe-Servers)
156+
- [Open Cloud](../cloud/guides/index.md) scripts (not synced to Studio) to [update a published experience](/cloud/reference/Universe#Cloud_UpdateUniverse) or [restart servers](/cloud/reference/Universe#Cloud_RestartUniverseServers)
157157

158158
## Assets
159159

content/en-us/reference/cloud/messaging-service/v1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.1",
33
"info": {
44
"title": "Messaging Service",
5-
"description": "This page contains reference documentation for the Open Cloud v1 Messaging Service API, which can broadcast messages across all servers in your experience.\n\nThe v2 API has its own version of the [Publish Message](/cloud/reference/Universe#Publish-Universe-Message) method. For information on using the v2 method, see the [Messaging usage guide](../../../cloud/guides/usage-messaging.md).",
5+
"description": "This page contains reference documentation for the Open Cloud v1 Messaging Service API, which can broadcast messages across all servers in your experience.\n\nThe v2 API has its own version of the [Publish Message](/cloud/reference/Universe#Cloud_PublishUniverseMessage) method. For information on using the v2 method, see the [Messaging usage guide](../../../cloud/guides/usage-messaging.md).",
66
"version": "v1",
77
"x-roblox-extensions-version": "1.0.0"
88
},

0 commit comments

Comments
 (0)