Skip to content

Commit 1744208

Browse files
rbx-open-source-docs[bot]rbx-open-source-docs[bot]
committed
update Open Source Docs from Roblox internal teams
1 parent f3594c5 commit 1744208

File tree

18 files changed

+428
-307
lines changed

18 files changed

+428
-307
lines changed

‎content/common/navigation/cloud/reference.yaml‎

Lines changed: 110 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -32,98 +32,117 @@ navigation:
3232
path: /cloud/auth/oauth2-sample
3333
- title: Reference
3434
path: /cloud/auth/oauth2-reference
35-
- heading: Use Case Reference
36-
- title: All features
37-
section:
38-
- title: Accounts
39-
path: /cloud/features/accounts
40-
- title: Assets
41-
path: /cloud/features/assets
42-
- title: Avatars
43-
path: /cloud/features/avatars
44-
- title: Badges
45-
path: /cloud/features/badges
46-
- title: Bans and blocks
47-
path: /cloud/features/bans-and-blocks
48-
- title: Chats
49-
path: /cloud/features/chats
50-
- title: Creator Store
51-
path: /cloud/features/creator-store
52-
- title: Developer products
53-
path: /cloud/features/developer-products
54-
- title: Friends
55-
path: /cloud/features/friends
56-
- title: Game passes
57-
path: /cloud/features/game-passes
58-
- title: Groups
59-
path: /cloud/features/groups
60-
- title: Interactions
61-
path: /cloud/features/interactions
62-
- title: Inventories
63-
path: /cloud/features/inventories
64-
- title: Localization
65-
path: /cloud/features/localization
66-
- title: Luau execution
67-
path: /cloud/features/luau-execution
68-
- title: Metadata
69-
path: /cloud/features/metadata
70-
- title: Notifications
71-
path: /cloud/features/notifications
72-
- title: Places
73-
path: /cloud/features/places
74-
- title: Private servers
75-
path: /cloud/features/private-servers
76-
- title: Sponsored campaigns
77-
path: /cloud/features/sponsored-campaigns
78-
- title: Storage
79-
path: /cloud/features/storage
80-
- title: Team Create
81-
path: /cloud/features/team-create
82-
- title: Thumbnails
83-
path: /cloud/features/thumbnails
84-
- title: Trades
85-
path: /cloud/features/trades
86-
- title: Universes
87-
path: /cloud/features/universes
88-
- title: User profiles
89-
path: /cloud/features/user-profiles
90-
- title: Users
91-
path: /cloud/features/users
92-
- heading: Open Cloud v2
93-
- title: All Cloud API # doesn't show anywhere
94-
path: /cloud/reference/
95-
type: cloudapi2
96-
source: /reference/cloud/cloud.docs.json
97-
- heading: Open Cloud v1
35+
- heading: Features
36+
- title: Accounts
37+
path: /cloud/features/accounts
9838
- title: Assets
99-
type: cloudapi
100-
versions:
101-
- name: v1
102-
path: /reference/cloud/assets/v1
103-
- title: Standard data stores
104-
type: cloudapi
105-
versions:
106-
- name: v1
107-
path: /reference/cloud/datastores-api/v1
108-
- title: Ordered data stores
109-
type: cloudapi
110-
versions:
111-
- name: v1
112-
path: /reference/cloud/datastores-api/ordered-v1
113-
- title: Messaging
114-
type: cloudapi
115-
versions:
116-
- name: v1
117-
path: /reference/cloud/messaging-service/v1
118-
- title: Place publishing
119-
type: cloudapi
120-
versions:
121-
- name: v1
122-
path: /reference/cloud/universes-api/v1
123-
- heading: Legacy
124-
- title: Overview
125-
path: /cloud/legacy
126-
- title: All legacy APIs
39+
path: /cloud/features/assets
40+
- title: Avatars
41+
path: /cloud/features/avatars
42+
- title: Badges
43+
path: /cloud/features/badges
44+
- title: Bans and blocks
45+
path: /cloud/features/bans-and-blocks
46+
- title: Chats
47+
path: /cloud/features/chats
48+
- title: Creator Store
49+
path: /cloud/features/creator-store
50+
- title: Developer products
51+
path: /cloud/features/developer-products
52+
- title: Friends
53+
path: /cloud/features/friends
54+
- title: Game passes
55+
path: /cloud/features/game-passes
56+
- title: Groups
57+
path: /cloud/features/groups
58+
- title: Interactions
59+
path: /cloud/features/interactions
60+
- title: Inventories
61+
path: /cloud/features/inventories
62+
- title: Localization
63+
path: /cloud/features/localization
64+
- title: Luau execution
65+
path: /cloud/features/luau-execution
66+
- title: Metadata
67+
path: /cloud/features/metadata
68+
- title: Notifications
69+
path: /cloud/features/notifications
70+
- title: Places
71+
path: /cloud/features/places
72+
- title: Private servers
73+
path: /cloud/features/private-servers
74+
- title: Sponsored campaigns
75+
path: /cloud/features/sponsored-campaigns
76+
- title: Storage
77+
path: /cloud/features/storage
78+
- title: Team Create
79+
path: /cloud/features/team-create
80+
- title: Thumbnails
81+
path: /cloud/features/thumbnails
82+
- title: Trades
83+
path: /cloud/features/trades
84+
- title: Universes
85+
path: /cloud/features/universes
86+
- title: User profiles
87+
path: /cloud/features/user-profiles
88+
- title: Users
89+
path: /cloud/features/users
90+
- heading: Open Cloud API Reference
91+
- title: Cloud
92+
section:
93+
- title: Toolbox service
94+
path: /cloud/api/toolbox-service
95+
- title: Asset delivery
96+
path: /cloud/api/asset-delivery
97+
- title: Badges
98+
path: /cloud/api/badges
99+
- title: Develop
100+
path: /cloud/api/develop
101+
- title: Followings
102+
path: /cloud/api/followings
103+
- title: Game internationalization
104+
path: /cloud/api/game-internationalization
105+
- title: Groups
106+
path: /cloud/api/groups
107+
- title: Localization tables
108+
path: /cloud/api/localization
109+
- title: Publish
110+
path: /cloud/api/publish
111+
- title: Open Cloud v2
112+
section:
113+
- title: All Cloud API # doesn't show anywhere
114+
path: /cloud/reference/
115+
type: cloudapi2
116+
source: /reference/cloud/cloud.docs.json
117+
- title: Open Cloud v1
118+
section:
119+
- title: Assets
120+
type: cloudapi
121+
versions:
122+
- name: v1
123+
path: /reference/cloud/assets/v1
124+
- title: Standard data stores
125+
type: cloudapi
126+
versions:
127+
- name: v1
128+
path: /reference/cloud/datastores-api/v1
129+
- title: Ordered data stores
130+
type: cloudapi
131+
versions:
132+
- name: v1
133+
path: /reference/cloud/datastores-api/ordered-v1
134+
- title: Messaging
135+
type: cloudapi
136+
versions:
137+
- name: v1
138+
path: /reference/cloud/messaging-service/v1
139+
- title: Place publishing
140+
type: cloudapi
141+
versions:
142+
- name: v1
143+
path: /reference/cloud/universes-api/v1
144+
- heading: Cookie-based API Reference
145+
- title: Legacy APIs
127146
section:
128147
- title: Account information
129148
type: cloudlegacy

‎content/en-us/cloud/api/asset-delivery.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Asset Delivery
3+
description: Asset delivery API on Roblox Cloud.
4+
---
5+
6+
## Asset delivery v1
7+
8+
import assetdeliveryV1 from '../legacy/assetdelivery/v1.json'
9+
10+
<SwaggerDocs
11+
spec={assetdeliveryV1}
12+
server="assetdelivery.roblox.com"
13+
serverOverride="apis.roblox.com/asset-delivery-api"
14+
showViewAllLink={false}
15+
endpoints={[
16+
{ path: "/v1/assetId/{assetId}", method: "get", scopesOverride: ["legacy-asset:manage"] },
17+
{ path: "/v1/assetId/{assetId}/version/{versionNumber}", method: "get", scopesOverride: ["legacy-asset:manage"] }
18+
]}
19+
/>

‎content/en-us/cloud/api/badges.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Badges
3+
description: Badges API on Roblox Cloud.
4+
---
5+
6+
## Badges v1
7+
8+
import badgesV1 from '../legacy/badges/v1.json'
9+
10+
<SwaggerDocs
11+
spec={badgesV1}
12+
server="badges.roblox.com"
13+
serverOverride="apis.roblox.com/legacy-badges"
14+
showViewAllLink={false}
15+
endpoints={[
16+
{ path: "/v1/badges/{badgeId}", method: "patch", scopesOverride: ["legacy-universe.badge:write", "legacy-universe.badge:manage-and-spend-robux"] },
17+
{ path: "/v1/universes/{universeId}/badges", method: "post", scopesOverride: ["legacy-universe.badge:manage-and-spend-robux"] }
18+
]}
19+
/>
20+
21+
Robux might be required to create a badge. To identify the number of remaining free badges you can create for the current UTC day in the specified universe, use the `/v1/universes/{universeId}/free-badges-quota` endpoint found [here](/cloud/legacy/badges/v1).

‎content/en-us/cloud/api/develop.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Develop
3+
description: Develop API on Roblox Cloud.
4+
---
5+
6+
## Develop v2
7+
8+
import developV2 from '../legacy/develop/v2.json'
9+
10+
<SwaggerDocs
11+
spec={developV2}
12+
server="develop.roblox.com"
13+
serverOverride="apis.roblox.com/legacy-develop"
14+
showViewAllLink={false}
15+
endpoints={[
16+
{ path: "/v2/teamtest/{placeId}", method: "delete", scopesOverride: ["legacy-team-collaboration:manage"] }
17+
]}
18+
/>
19+
20+
## Develop v1
21+
22+
import developV1 from '../legacy/develop/v1.json'
23+
24+
<SwaggerDocs
25+
spec={developV1}
26+
server="develop.roblox.com"
27+
serverOverride="apis.roblox.com/legacy-develop"
28+
showViewAllLink={false}
29+
endpoints={[
30+
{ path: "/v1/places/{placeId}/teamcreate/active_session/members", method: "get", scopesOverride: ["legacy-team-collaboration:manage"] },
31+
{ path: "/v1/universes/{universeId}/activate", method: "post", scopesOverride: ["legacy-universe:manage"] },
32+
{ path: "/v1/universes/{universeId}/deactivate", method: "post", scopesOverride: ["legacy-universe:manage"] },
33+
{ path: "/v1/universes/{universeId}/permissions", method: "get", scopesOverride: ["legacy-universe:manage"] },
34+
{ path: "/v1/universes/{universeId}/teamcreate", method: "patch", scopesOverride: ["legacy-team-collaboration:manage"] },
35+
{ path: "/v1/universes/{universeId}/teamcreate", method: "get", scopesOverride: ["legacy-team-collaboration:manage"] },
36+
{ path: "/v1/universes/{universeId}/teamcreate/memberships", method: "delete", scopesOverride: ["legacy-team-collaboration:manage"] },
37+
{ path: "/v1/universes/multiget/permissions", method: "get", scopesOverride: ["legacy-universe:manage"] },
38+
{ path: "/v1/universes/multiget/teamcreate", method: "get", scopesOverride: ["legacy-team-collaboration:manage"] },
39+
{ path: "/v1/user/groups/canmanage", method: "get", scopesOverride: ["legacy-group:manage"] }
40+
]}
41+
/>

‎content/en-us/cloud/api/followings.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Followings
3+
description: Followings API on Roblox Cloud.
4+
---
5+
6+
## Followings v2
7+
8+
import followingsV2 from '../legacy/followings/v2.json'
9+
10+
<SwaggerDocs
11+
spec={followingsV2}
12+
server="followings.roblox.com"
13+
serverOverride="apis.roblox.com/legacy-followings"
14+
showViewAllLink={false}
15+
endpoints={[
16+
{ path: "/v2/users/{userId}/universes", method: "get", scopesOverride: ["legacy-universe.following:read"] }
17+
]}
18+
/>
19+
20+
## Followings v1
21+
22+
import followingsV1 from '../legacy/followings/v1.json'
23+
24+
<SwaggerDocs
25+
spec={followingsV1}
26+
server="followings.roblox.com"
27+
serverOverride="apis.roblox.com/legacy-followings"
28+
showViewAllLink={false}
29+
endpoints={[
30+
{ path: "/v1/users/{userId}/universes", method: "get", scopesOverride: ["legacy-universe.following:read"] },
31+
{ path: "/v1/users/{userId}/universes/{universeId}", method: "post", scopesOverride: ["legacy-universe.following:write"] },
32+
{ path: "/v1/users/{userId}/universes/{universeId}", method: "delete", scopesOverride: ["legacy-universe.following:write"] },
33+
{ path: "/v1/users/{userId}/universes/{universeId}/status", method: "get", scopesOverride: ["legacy-universe.following:read"] }
34+
]}
35+
/>

‎content/en-us/cloud/api/game-internationalization.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Game internationalization
3+
description: Game internationalization API on Roblox Cloud.
4+
---
5+
6+
## Game internationalization v1
7+
8+
import gameinternationalizationV1 from '../legacy/gameinternationalization/v1.json'
9+
10+
<SwaggerDocs
11+
spec={gameinternationalizationV1}
12+
server="gameinternationalization.roblox.com"
13+
serverOverride="apis.roblox.com/legacy-game-internationalization"
14+
showViewAllLink={false}
15+
endpoints={[
16+
{ path: "/v1/badges/{badgeId}/description/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-badge:manage"] },
17+
{ path: "/v1/badges/{badgeId}/icons", method: "get", scopesOverride: ["legacy-badge:manage"] },
18+
{ path: "/v1/badges/{badgeId}/icons/language-codes/{languageCode}", method: "post", scopesOverride: ["legacy-badge:manage"] },
19+
{ path: "/v1/badges/{badgeId}/icons/language-codes/{languageCode}", method: "delete", scopesOverride: ["legacy-badge:manage"] },
20+
{ path: "/v1/badges/{badgeId}/name-description", method: "get", scopesOverride: ["legacy-badge:manage"] },
21+
{ path: "/v1/badges/{badgeId}/name-description/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-badge:manage"] },
22+
{ path: "/v1/badges/{badgeId}/name-description/language-codes/{languageCode}", method: "delete", scopesOverride: ["legacy-badge:manage"] },
23+
{ path: "/v1/badges/{badgeId}/name/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-badge:manage"] },
24+
{ path: "/v1/developer-products/{developerProductId}/description/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-developer-product:manage"] },
25+
{ path: "/v1/developer-products/{developerProductId}/icons", method: "get", scopesOverride: ["legacy-developer-product:manage"] },
26+
{ path: "/v1/developer-products/{developerProductId}/icons/language-codes/{languageCode}", method: "post", scopesOverride: ["legacy-developer-product:manage"] },
27+
{ path: "/v1/developer-products/{developerProductId}/icons/language-codes/{languageCode}", method: "delete", scopesOverride: ["legacy-developer-product:manage"] },
28+
{ path: "/v1/developer-products/{developerProductId}/name-description", method: "get", scopesOverride: ["legacy-developer-product:manage"] },
29+
{ path: "/v1/developer-products/{developerProductId}/name-description/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-developer-product:manage"] },
30+
{ path: "/v1/developer-products/{developerProductId}/name-description/language-codes/{languageCode}", method: "delete", scopesOverride: ["legacy-developer-product:manage"] },
31+
{ path: "/v1/developer-products/{developerProductId}/name/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-developer-product:manage"] },
32+
{ path: "/v1/game-icon/games/{gameId}", method: "get", scopesOverride: ["legacy-universe:manage:manage"] },
33+
{ path: "/v1/game-icon/games/{gameId}/language-codes/{languageCode}", method: "post", scopesOverride: ["legacy-universe:manage:manage"] },
34+
{ path: "/v1/game-icon/games/{gameId}/language-codes/{languageCode}", method: "delete", scopesOverride: ["legacy-universe:manage:manage"] },
35+
{ path: "/v1/game-passes/{gamePassId}/description/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-game-pass:manage:manage"] },
36+
{ path: "/v1/game-passes/{gamePassId}/icons", method: "get", scopesOverride: ["legacy-game-pass:manage:manage"] },
37+
{ path: "/v1/game-passes/{gamePassId}/icons/language-codes/{languageCode}", method: "post", scopesOverride: ["legacy-game-pass:manage:manage"] },
38+
{ path: "/v1/game-passes/{gamePassId}/icons/language-codes/{languageCode}", method: "delete", scopesOverride: ["legacy-game-pass:manage:manage"] },
39+
{ path: "/v1/game-passes/{gamePassId}/name-description", method: "get", scopesOverride: ["legacy-game-pass:manage:manage"] },
40+
{ path: "/v1/game-passes/{gamePassId}/name-description/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-game-pass:manage:manage"] },
41+
{ path: "/v1/game-passes/{gamePassId}/name-description/language-codes/{languageCode}", method: "delete", scopesOverride: ["legacy-game-pass:manage:manage"] },
42+
{ path: "/v1/game-passes/{gamePassId}/name/language-codes/{languageCode}", method: "patch", scopesOverride: ["legacy-game-pass:manage:manage"] },
43+
{ path: "/v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/alt-text", method: "post", scopesOverride: ["legacy-universe:manage"] },
44+
{ path: "/v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/image", method: "post", scopesOverride: ["legacy-universe:manage"] },
45+
{ path: "/v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/images/{imageId}", method: "delete", scopesOverride: ["legacy-universe:manage"] },
46+
{ path: "/v1/game-thumbnails/games/{gameId}/language-codes/{languageCode}/images/order", method: "post", scopesOverride: ["legacy-universe:manage"] },
47+
{ path: "/v1/name-description/games/{gameId}", method: "patch", scopesOverride: ["legacy-universe:manage"] },
48+
{ path: "/v1/name-description/games/translation-history", method: "post", scopesOverride: ["legacy-universe:manage"] },
49+
{ path: "/v1/source-language/games/{gameId}", method: "patch", scopesOverride: ["legacy-universe:manage"] },
50+
{ path: "/v1/supported-languages/games/{gameId}", method: "patch", scopesOverride: ["legacy-universe:manage"] },
51+
{ path: "/v1/supported-languages/games/{gameId}/automatic-translation-status", method: "get", scopesOverride: ["legacy-universe:manage"] },
52+
{ path: "/v1/supported-languages/games/{gameId}/languages/{languageCode}/automatic-translation-status", method: "patch", scopesOverride: ["legacy-universe:manage"] },
53+
{ path: "/v1/supported-languages/games/{gameId}/languages/{languageCode}/universe-display-info-automatic-translation-settings", method: "patch", scopesOverride: ["legacy-universe:manage"] },
54+
{ path: "/v1/supported-languages/games/{gameId}/universe-display-info-automatic-translation-settings", method: "get", scopesOverride: ["legacy-universe:manage"] }
55+
]}
56+
/>

0 commit comments

Comments
 (0)