Skip to content

Commit 2c679df

Browse files
update Open Source Docs from Roblox internal teams
1 parent af94355 commit 2c679df

File tree

7 files changed

+201
-74
lines changed

7 files changed

+201
-74
lines changed

content/common/navigation/cloud/reference.yaml

Lines changed: 115 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,63 @@ navigation:
2727
path: /cloud/reference/errors
2828
- title: OpenAPI descriptions
2929
path: /cloud/reference/openapi
30+
- heading: Use Case Reference
31+
- title: All features
32+
section:
33+
- title: Accounts
34+
path: /cloud/features/accounts
35+
- title: Assets
36+
path: /cloud/features/assets
37+
- title: Avatars
38+
path: /cloud/features/avatars
39+
- title: Badges
40+
path: /cloud/features/badges
41+
- title: Bans and blocks
42+
path: /cloud/features/bans-and-blocks
43+
- title: Chats
44+
path: /cloud/features/chats
45+
- title: Creator Store
46+
path: /cloud/features/creator-store
47+
- title: Developer products
48+
path: /cloud/features/developer-products
49+
- title: Friends
50+
path: /cloud/features/friends
51+
- title: Game passes
52+
path: /cloud/features/game-passes
53+
- title: Groups
54+
path: /cloud/features/groups
55+
- title: Interactions
56+
path: /cloud/features/interactions
57+
- title: Inventories
58+
path: /cloud/features/inventories
59+
- title: Localization
60+
path: /cloud/features/localization
61+
- title: Luau execution
62+
path: /cloud/features/luau-execution
63+
- title: Metadata
64+
path: /cloud/features/metadata
65+
- title: Notifications
66+
path: /cloud/features/notifications
67+
- title: Places
68+
path: /cloud/features/places
69+
- title: Private servers
70+
path: /cloud/features/private-servers
71+
- title: Sponsored campaigns
72+
path: /cloud/features/sponsored-campaigns
73+
- title: Storage
74+
path: /cloud/features/storage
75+
- title: Team Create
76+
path: /cloud/features/team-create
77+
- title: Thumbnails
78+
path: /cloud/features/thumbnails
79+
- title: Trades
80+
path: /cloud/features/trades
81+
- title: Universes
82+
path: /cloud/features/universes
83+
- title: User profiles
84+
path: /cloud/features/user-profiles
85+
- title: Users
86+
path: /cloud/features/users
3087
- heading: Open Cloud v2
3188
- title: All Cloud API # doesn't show anywhere
3289
path: /cloud/reference/
@@ -39,7 +96,6 @@ navigation:
3996
- name: v1
4097
path: /reference/cloud/assets/v1
4198
- title: Data stores
42-
path: /reference/cloud/datastores-api/v1
4399
section:
44100
- title: Standard data stores
45101
type: cloudapi
@@ -65,7 +121,6 @@ navigation:
65121
- title: Overview
66122
path: /cloud/legacy
67123
- title: Accounts
68-
path: /cloud/legacy/accountinformation/v1
69124
section:
70125
- title: Account information
71126
type: cloudlegacy
@@ -97,14 +152,19 @@ navigation:
97152
versions:
98153
- name: v1
99154
path: /cloud/legacy/auth/v1
155+
- title: Private messages
156+
type: cloudlegacy
157+
ignoreTranslation: true
158+
versions:
159+
- name: v1
160+
path: /cloud/legacy/privatemessages/v1
100161
- title: Two-step verification
101162
type: cloudlegacy
102163
ignoreTranslation: true
103164
versions:
104165
- name: v1
105166
path: /cloud/legacy/twostepverification/v1
106167
- title: Assets
107-
path: /cloud/legacy/assetdelivery/v2
108168
section:
109169
- title: Asset delivery v2
110170
type: cloudlegacy
@@ -143,7 +203,6 @@ navigation:
143203
- name: v1
144204
path: /cloud/legacy/publish/v1
145205
- title: Avatar
146-
path: /cloud/legacy/avatar/v3
147206
section:
148207
- title: Avatar v3
149208
type: cloudlegacy
@@ -164,7 +223,6 @@ navigation:
164223
- name: v1
165224
path: /cloud/legacy/avatar/v1
166225
- title: Localization
167-
path: /cloud/legacy/economy/v1
168226
section:
169227
- title: Economy
170228
type: cloudlegacy
@@ -203,7 +261,6 @@ navigation:
203261
- name: v1
204262
path: /cloud/legacy/translationroles/v1
205263
- title: Metadata
206-
path: /cloud/legacy/clientsettings/v2
207264
section:
208265
- title: Client settings v2
209266
type: cloudlegacy
@@ -218,7 +275,6 @@ navigation:
218275
- name: v1
219276
path: /cloud/legacy/clientsettings/v1
220277
- title: Thumbnails
221-
path: /cloud/legacy/thumbnails/v1
222278
section:
223279
- title: Thumbnails
224280
type: cloudlegacy
@@ -238,144 +294,136 @@ navigation:
238294
versions:
239295
- name: v1
240296
path: /cloud/legacy/metrics/v1
241-
- title: Users and groups
242-
path: /cloud/legacy/contacts/v1
297+
- title: Universes
243298
section:
244-
- title: Contacts
299+
- title: Badges
245300
type: cloudlegacy
246301
ignoreTranslation: true
247302
versions:
248303
- name: v1
249-
path: /cloud/legacy/contacts/v1
250-
- title: Followings v2
304+
path: /cloud/legacy/badges/v1
305+
- title: Chat
251306
type: cloudlegacy
252307
ignoreTranslation: true
253308
versions:
254309
- name: v2
255-
path: /cloud/legacy/followings/v2
256-
- title: Followings v1
310+
path: /cloud/legacy/chat/v2
311+
- title: Develop v2
257312
type: cloudlegacy
258313
ignoreTranslation: true
259314
versions:
260-
- name: v1
261-
path: /cloud/legacy/followings/v1
262-
- title: Friends
315+
- name: v2
316+
path: /cloud/legacy/develop/v2
317+
- title: Develop v1
263318
type: cloudlegacy
264319
ignoreTranslation: true
265320
versions:
266321
- name: v1
267-
path: /cloud/legacy/friends/v1
268-
- title: Groups v2
269-
type: cloudlegacy
270-
ignoreTranslation: true
271-
versions:
272-
- name: v2
273-
path: /cloud/legacy/groups/v2
274-
- title: Groups v1
322+
path: /cloud/legacy/develop/v1
323+
- title: Economy creator stats
275324
type: cloudlegacy
276325
ignoreTranslation: true
277326
versions:
278327
- name: v1
279-
path: /cloud/legacy/groups/v1
280-
- title: Inventory v2
328+
path: /cloud/legacy/economycreatorstats/v1
329+
- title: Engagement payouts
281330
type: cloudlegacy
282331
ignoreTranslation: true
283332
versions:
284-
- name: v2
285-
path: /cloud/legacy/inventory/v2
286-
- title: Inventory v1
333+
- name: v1
334+
path: /cloud/legacy/engagementpayouts/v1
335+
- title: Game join
287336
type: cloudlegacy
288337
ignoreTranslation: true
289338
versions:
290339
- name: v1
291-
path: /cloud/legacy/inventory/v1
292-
- title: Presence
340+
path: /cloud/legacy/gamejoin/v1
341+
- title: Games v2
293342
type: cloudlegacy
294343
ignoreTranslation: true
295344
versions:
296-
- name: v1
297-
path: /cloud/legacy/presence/v1
298-
- title: Users
345+
- name: v2
346+
path: /cloud/legacy/games/v2
347+
- title: Games v1
299348
type: cloudlegacy
300349
ignoreTranslation: true
301350
versions:
302351
- name: v1
303-
path: /cloud/legacy/users/v1
304-
- title: Premium features
352+
path: /cloud/legacy/games/v1
353+
- title: Users and groups
354+
section:
355+
- title: Contacts
305356
type: cloudlegacy
306357
ignoreTranslation: true
307358
versions:
308359
- name: v1
309-
path: /cloud/legacy/premiumfeatures/v1
310-
- title: Private messages
360+
path: /cloud/legacy/contacts/v1
361+
- title: Followings v2
311362
type: cloudlegacy
312363
ignoreTranslation: true
313364
versions:
314-
- name: v1
315-
path: /cloud/legacy/privatemessages/v1
316-
- title: Trades
365+
- name: v2
366+
path: /cloud/legacy/followings/v2
367+
- title: Followings v1
317368
type: cloudlegacy
318369
ignoreTranslation: true
319370
versions:
320371
- name: v1
321-
path: /cloud/legacy/trades/v1
322-
- title: Universes
323-
path: /cloud/legacy/badges/v1
324-
section:
325-
- title: Badges
372+
path: /cloud/legacy/followings/v1
373+
- title: Friends
326374
type: cloudlegacy
327375
ignoreTranslation: true
328376
versions:
329377
- name: v1
330-
path: /cloud/legacy/badges/v1
331-
- title: Chat
378+
path: /cloud/legacy/friends/v1
379+
- title: Groups v2
332380
type: cloudlegacy
333381
ignoreTranslation: true
334382
versions:
335383
- name: v2
336-
path: /cloud/legacy/chat/v2
337-
- title: Develop v2
384+
path: /cloud/legacy/groups/v2
385+
- title: Groups v1
338386
type: cloudlegacy
339387
ignoreTranslation: true
340388
versions:
341-
- name: v2
342-
path: /cloud/legacy/develop/v2
343-
- title: Develop v1
389+
- name: v1
390+
path: /cloud/legacy/groups/v1
391+
- title: Inventory v2
344392
type: cloudlegacy
345393
ignoreTranslation: true
346394
versions:
347-
- name: v1
348-
path: /cloud/legacy/develop/v1
349-
- title: Economy creator stats
395+
- name: v2
396+
path: /cloud/legacy/inventory/v2
397+
- title: Inventory v1
350398
type: cloudlegacy
351399
ignoreTranslation: true
352400
versions:
353401
- name: v1
354-
path: /cloud/legacy/economycreatorstats/v1
355-
- title: Engagement payouts
402+
path: /cloud/legacy/inventory/v1
403+
- title: Presence
356404
type: cloudlegacy
357405
ignoreTranslation: true
358406
versions:
359407
- name: v1
360-
path: /cloud/legacy/engagementpayouts/v1
361-
- title: Game join
408+
path: /cloud/legacy/presence/v1
409+
- title: Users
362410
type: cloudlegacy
363411
ignoreTranslation: true
364412
versions:
365413
- name: v1
366-
path: /cloud/legacy/gamejoin/v1
367-
- title: Games v2
414+
path: /cloud/legacy/users/v1
415+
- title: Premium features
368416
type: cloudlegacy
369417
ignoreTranslation: true
370418
versions:
371-
- name: v2
372-
path: /cloud/legacy/games/v2
373-
- title: Games v1
419+
- name: v1
420+
path: /cloud/legacy/premiumfeatures/v1
421+
- title: Trades
374422
type: cloudlegacy
375423
ignoreTranslation: true
376424
versions:
377425
- name: v1
378-
path: /cloud/legacy/games/v1
426+
path: /cloud/legacy/trades/v1
379427
- title: Ad configuration
380428
type: cloudlegacy
381429
ignoreTranslation: true

content/en-us/cloud/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Roblox has four categories of HTTP REST API:
1414
- [Legacy with API key and/or OAuth 2.0 authentication](legacy.md)
1515
- [Legacy with cookie authentication](legacy.md)
1616

17-
Whenever possible, use the Open Cloud v2 API. This API has the strongest stability guarantees and regularly adds new resources. The Open Cloud v1 API also has strong stability guarantees, but a more limited set of resources.
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.
1818

19-
The legacy APIs, no matter which types of authentication they support, can incorporate breaking changes without notice and have minimal stability guarantees. They are not part of the Open Cloud v2 or v1 APIs, and we don't recommend them for production applications.
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.
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/legacy.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@ description: Lists legacy REST APIs for Open Cloud.
55

66
This section contains documentation for Roblox's legacy REST APIs.
77

8-
- Roblox offers API key and/or OAuth 2.0 support **for the select legacy API endpoints listed on this page**. See the tables below for the list of available operations and authentication types.
8+
- Roblox offers API key and/or OAuth 2.0 support **for the select legacy API endpoints listed on this page**. These endpoints have the same stability guarantees as the Open Cloud v2 and v1 APIs. See the tables below for the list of available operations and authentication types.
99

10-
- All other legacy API endpoints use cookie-based authentication. We do not recommend depending on these APIs, as they rely on sharing cookies with application code.
11-
12-
- All legacy APIs, regardless of authentication type, can change without notice and do not have the stability guarantees of the Open Cloud APIs. See the left navigation for the full list of legacy API endpoints.
10+
- All other legacy API endpoints use cookie-based authentication. We do not recommend depending on these APIs, as they can incorporate breaking changes without notice and rely on sharing cookies with application code.
1311

1412
## Badges API
1513

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Legacy API warning
3+
---
4+
5+
<Alert severity="warning">
6+
Legacy APIs with cookie authentication can incorporate breaking changes without notice. We don't recommend them for production applications.
7+
</Alert>

content/en-us/reference/cloud/assets/v1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@
269269
"application/json": {
270270
"schema": {
271271
"$ref": "#/components/schemas/Operation",
272-
"example": "{\\\"previews\\\": [\\n {\\\"asset\\\": \\\"assets/123\\\", \\\"altText\\\": \\\"preview 1\\\"},\\n {\\\"asset\\\": \\\"assets/456\\\", \\\"altText\\\": \\\"preview 2\\\"}\\n]}"
272+
"example": "{\"previews\": [\n {\"asset\": \"assets/123\", \"altText\": \"preview 1\"},\n {\"asset\": \"assets/456\", \"altText\": \"preview 2\"}\n]}"
273273
}
274274
}
275275
}

0 commit comments

Comments
 (0)