Skip to content

Commit e51b20c

Browse files
update Open Source Docs from Roblox internal teams
1 parent 73ef770 commit e51b20c

33 files changed

+299
-405
lines changed

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

Lines changed: 26 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,27 @@ All endpoints use your universe ID, which you can find on the [Creator Dashboard
1818

1919
For the full endpoint reference, request and response schemas, and error codes, see the [Cloud API reference](/cloud/reference).
2020

21-
## Repositories and namespaces
21+
## Repositories
2222

23-
Many requests to the configs endpoints require a **repository** in the path and a **namespace** in the request body. For example, this request adds a draft config:
23+
Requests to the configs endpoints use a **repository** in the path and an **entries** object in the request body. For example, this request adds a draft config:
2424

2525
```json
26-
PUT /creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/<REPOSITORY>
26+
PATCH /creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/<REPOSITORY>/draft
2727
{
28-
"namespaces": {
29-
"<NAMESPACE>": {
30-
"enableNewTutorial": true
31-
}
28+
"entries": {
29+
"enableNewTutorial": true
3230
}
3331
}
3432
```
3533

36-
- Repositories differ by product. They separate configs by system.
37-
- Namespaces are groupings within a product. They organize keys or mark them as being for some particular purpose.
34+
- **Repositories** differ by product and separate configs by system.
35+
- **Entries** are the config key-value pairs. You send and receive a single flat object of keys and values.
3836

39-
This guide covers in-experience configs, so all requests use `UniverseConfiguration` for repository and `UniverseConfigurations` for namespace. Repositories and namespaces will eventually expand to cover additional products and use cases.
37+
This guide covers in-experience configs, so all requests use `InExperienceConfig` for repository. Repositories will eventually expand to cover additional products and use cases.
4038

41-
| Use case | Repository | Supported namespaces |
42-
| --------------------- | ----------------------- | ------------------------ |
43-
| In-experience configs | `UniverseConfiguration` | `UniverseConfigurations` |
39+
| Use case | Repository |
40+
| --------------------- | -------------------- |
41+
| In-experience configs | `InExperienceConfig` |
4442

4543
## Create or update configs
4644

@@ -49,7 +47,7 @@ Before going live, config changes are staged as drafts. You can either set the e
4947
- **Starting from scratch or replacing everything** — Use the overwrite endpoint so that the payload is the full desired state. Any key you omit is treated as removed.
5048
- **Changing only some keys** — Use the partial update endpoint so only the keys you send are updated; everything else stays as-is.
5149

52-
This sample code sets `bossHealth` to `100` in the `UniverseConfigurations` namespace and uses the overwrite endpoint:
50+
This sample code sets `bossHealth` to `100` and uses the overwrite endpoint:
5351

5452
<Tabs>
5553
<TabItem key="1" label="Python">
@@ -59,15 +57,13 @@ import requests
5957

6058
API_KEY = "<API_KEY>"
6159
UNIVERSE_ID = "<UNIVERSE_ID>"
62-
BASE = f"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/{UNIVERSE_ID}/repositories/UniverseConfiguration"
60+
BASE = f"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/{UNIVERSE_ID}/repositories/InExperienceConfig"
6361
headers = {"x-api-key": API_KEY, "Content-Type": "application/json"}
6462

6563
# Optional: send previousDraftHash if you have an existing draft and want optimistic concurrency
6664
payload = {
67-
"namespaces": {
68-
"UniverseConfigurations": {
69-
"bossHealth": 100
70-
}
65+
"entries": {
66+
"bossHealth": 100
7167
}
7268
}
7369
r = requests.put(f"{BASE}/draft:overwrite", headers=headers, json=payload)
@@ -82,16 +78,16 @@ print("Draft staged. draftHash:", draft_hash)
8278

8379
```bash
8480
curl --request PUT \
85-
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/UniverseConfiguration/draft:overwrite" \
81+
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/InExperienceConfig/draft:overwrite" \
8682
--header "x-api-key: <API_KEY>" \
8783
--header "Content-Type: application/json" \
88-
--data '{"namespaces":{"UniverseConfigurations":{"bossHealth":100}}}'
84+
--data '{"entries":{"bossHealth":100}}'
8985
```
9086

9187
</TabItem>
9288
</Tabs>
9389

94-
The response includes the `draftHash` value. You need this hash in order to publish. If you prefer to only tweak a few keys in your draft, use the PATCH method on the `/draft` endpoint and only send the namespaces and keys you want to change.
90+
The response includes the `draftHash` value. You need this hash in order to publish. If you prefer to only tweak a few keys in your draft, use the PATCH method on the `/draft` endpoint and only send the entries (keys) you want to change.
9591

9692
### About draft hashes
9793

@@ -126,7 +122,7 @@ print("Published. configVersion:", result["configVersion"])
126122
```bash
127123
# Use the draftHash from the previous step
128124
curl --request POST \
129-
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/UniverseConfiguration/publish" \
125+
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/InExperienceConfig/publish" \
130126
--header "x-api-key: <API_KEY>" \
131127
--header "Content-Type: application/json" \
132128
--data '{
@@ -159,7 +155,7 @@ To confirm the change went through, fetch the latest published config. Use the v
159155
r = requests.get(BASE, headers=headers)
160156
r.raise_for_status()
161157
config = r.json()
162-
boss_health = config["namespaces"]["UniverseConfigurations"].get("bossHealth")
158+
boss_health = config["entries"].get("bossHealth")
163159
print("Published bossHealth:", boss_health) # Should be 100
164160

165161
# Or with full metadata:
@@ -171,14 +167,14 @@ print("Published bossHealth:", boss_health) # Should be 100
171167

172168
```bash
173169
curl --location \
174-
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/UniverseConfiguration" \
170+
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/InExperienceConfig" \
175171
--header "x-api-key: <API_KEY>"
176172
```
177173

178174
</TabItem>
179175
</Tabs>
180176

181-
Verify that `namespaces.UniverseConfigurations.bossHealth` (or your key) matches what you published.
177+
Verify that `entries.bossHealth` (or your key) matches what you published.
182178

183179
## View history and roll back
184180

@@ -202,7 +198,7 @@ for rev in data["revisions"]:
202198

203199
```bash
204200
curl --location \
205-
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/UniverseConfiguration/revisions?MaxPageSize=10" \
201+
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/InExperienceConfig/revisions?MaxPageSize=10" \
206202
--header "x-api-key: <API_KEY>"
207203
```
208204

@@ -238,12 +234,12 @@ print("Rollback published. configVersion:", r.json()["configVersion"])
238234
```bash
239235
# 1) Restore (returns a new draftHash)
240236
curl --request POST \
241-
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/UniverseConfiguration/revisions/<REVISION_ID>/restore" \
237+
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/InExperienceConfig/revisions/<REVISION_ID>/restore" \
242238
--header "x-api-key: <API_KEY>"
243239

244240
# 2) Publish the reverted draft using the draftHash from the response
245241
curl --request POST \
246-
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/UniverseConfiguration/publish" \
242+
"https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/InExperienceConfig/publish" \
247243
--header "x-api-key: <API_KEY>" \
248244
--header "Content-Type: application/json" \
249245
--data '{"draftHash":"<DRAFT_HASH>","message":"Rollback","deploymentStrategy":"Immediate"}'
@@ -257,7 +253,7 @@ curl --request POST \
257253
| Limit | Maximum |
258254
| ----------------------- | -------------- |
259255
| **Keys per repository** | 100 |
260-
| **Key length** | 250 characters |
256+
| **Key length** | 256 characters |
261257

262258
Requests that exceed these limits will fail. For type-specific value limits (e.g. string vs JSON) in your experience, see [Limits](../../production/configs.md#limits) in the experience configs guide.
263259

content/en-us/reference/engine/classes/BaseScript.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,8 @@ properties:
127127
serialization:
128128
can_load: true
129129
can_save: true
130-
capabilities: []
130+
capabilities:
131+
- LoadUnownedAsset
131132
- name: BaseScript.RunContext
132133
summary: |
133134
Determines the context under which the script will run.

content/en-us/reference/engine/classes/CapturesViewConfiguration.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ properties:
3131
serialization:
3232
can_load: true
3333
can_save: true
34-
capabilities: []
34+
capabilities:
35+
- UI
36+
- Capture
3537
methods: []
3638
events: []
3739
callbacks: []

content/en-us/reference/engine/classes/CoreGuiConfiguration.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@ properties:
3232
serialization:
3333
can_load: true
3434
can_save: true
35-
capabilities: []
35+
capabilities:
36+
- UI
37+
- Capture
3638
- name: CoreGuiConfiguration.PlayerListConfiguration
3739
summary: ''
3840
description: ''
@@ -48,7 +50,8 @@ properties:
4850
serialization:
4951
can_load: true
5052
can_save: true
51-
capabilities: []
53+
capabilities:
54+
- UI
5255
- name: CoreGuiConfiguration.SelfViewConfiguration
5356
summary: ''
5457
description: ''
@@ -64,7 +67,8 @@ properties:
6467
serialization:
6568
can_load: true
6669
can_save: true
67-
capabilities: []
70+
capabilities:
71+
- UI
6872
methods: []
6973
events: []
7074
callbacks: []

0 commit comments

Comments
 (0)