Skip to content

Commit 482b37f

Browse files
rbx-open-source-docs[bot]rbx-open-source-docs[bot]
committed
update Open Source Docs from Roblox internal teams
1 parent 1532deb commit 482b37f

File tree

6 files changed

+123
-140
lines changed

6 files changed

+123
-140
lines changed

‎content/en-us/includes/cloud/legacy-note.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Legacy API with API key note
3+
---
4+
5+
<Alert severity="info">
6+
Legacy endpoints that support API key and/or OAuth 2.0 authentication have the same beta stability guarantees as the Open Cloud APIs. Breaking changes are possible but rare.
7+
</Alert>

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

Lines changed: 32 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@
8080
"roblox-oauth2": ["asset:read", "asset:write"]
8181
}
8282
],
83-
"x-roblox-scopes": {
84-
"required": ["asset:read", "asset:write"],
85-
"conditional": []
86-
},
83+
"x-roblox-scopes": [
84+
{ "name": "asset:read" },
85+
{ "name": "asset:write" }
86+
],
8787
"x-roblox-cloud-api-operation-code-samples": [
8888
{
8989
"language": "Create Asset",
@@ -175,10 +175,9 @@
175175
"roblox-oauth2": ["asset:read"]
176176
}
177177
],
178-
"x-roblox-scopes": {
179-
"required": ["asset:read"],
180-
"conditional": []
181-
},
178+
"x-roblox-scopes": [
179+
{ "name": "asset:read" }
180+
],
182181
"x-roblox-cloud-api-operation-code-samples": [
183182
{
184183
"language": "Get Asset without readMask",
@@ -299,10 +298,10 @@
299298
"roblox-oauth2": ["asset:read", "asset:write"]
300299
}
301300
],
302-
"x-roblox-scopes": {
303-
"required": ["asset:read", "asset:write"],
304-
"conditional": []
305-
},
301+
"x-roblox-scopes": [
302+
{ "name": "asset:read" },
303+
{ "name": "asset:write" }
304+
],
306305
"x-roblox-cloud-api-operation-code-samples": [
307306
{
308307
"language": "Update Content Only and Create a New Version",
@@ -386,10 +385,10 @@
386385
"roblox-oauth2": ["asset:read", "asset:write"]
387386
}
388387
],
389-
"x-roblox-scopes": {
390-
"required": ["asset:read", "asset:write"],
391-
"conditional": []
392-
},
388+
"x-roblox-scopes": [
389+
{ "name": "asset:read" },
390+
{ "name": "asset:write" }
391+
],
393392
"x-roblox-cloud-api-operation-code-samples": [
394393
{
395394
"language": "Archive Asset",
@@ -461,10 +460,10 @@
461460
"roblox-oauth2": ["asset:read", "asset:write"]
462461
}
463462
],
464-
"x-roblox-scopes": {
465-
"required": ["asset:read", "asset:write"],
466-
"conditional": []
467-
},
463+
"x-roblox-scopes": [
464+
{ "name": "asset:read" },
465+
{ "name": "asset:write" }
466+
],
468467
"x-roblox-cloud-api-operation-code-samples": [
469468
{
470469
"language": "Restore Asset",
@@ -542,10 +541,9 @@
542541
"roblox-oauth2": ["asset:read"]
543542
}
544543
],
545-
"x-roblox-scopes": {
546-
"required": ["asset:read"],
547-
"conditional": []
548-
},
544+
"x-roblox-scopes": [
545+
{ "name": "asset:read" }
546+
],
549547
"x-roblox-cloud-api-operation-code-samples": [
550548
{
551549
"language": "Get Asset Version",
@@ -632,10 +630,9 @@
632630
"roblox-oauth2": ["asset:read"]
633631
}
634632
],
635-
"x-roblox-scopes": {
636-
"required": ["asset:read"],
637-
"conditional": []
638-
},
633+
"x-roblox-scopes": [
634+
{ "name": "asset:read" }
635+
],
639636
"x-roblox-cloud-api-operation-code-samples": [
640637
{
641638
"language": "List Asset Versions",
@@ -725,10 +722,10 @@
725722
"roblox-oauth2": ["asset:read", "asset:write"]
726723
}
727724
],
728-
"x-roblox-scopes": {
729-
"required": ["asset:read", "asset:write"],
730-
"conditional": []
731-
},
725+
"x-roblox-scopes": [
726+
{ "name": "asset:read" },
727+
{ "name": "asset:write" }
728+
],
732729
"x-roblox-rate-limits": {
733730
"perIp": {
734731
"period": "MINUTE",
@@ -811,10 +808,9 @@
811808
"roblox-oauth2": ["asset:read"]
812809
}
813810
],
814-
"x-roblox-scopes": {
815-
"required": ["asset:read"],
816-
"conditional": []
817-
},
811+
"x-roblox-scopes": [
812+
{ "name": "asset:read" }
813+
],
818814
"x-roblox-cloud-api-operation-code-samples": [
819815
{
820816
"language": "Get Operation",

‎content/en-us/reference/cloud/datastores-api/ordered-v1.json‎

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,9 @@
106106
"roblox-api-key": ["Label.Read"]
107107
}
108108
],
109-
"x-roblox-scopes": {
110-
"required": ["universe.ordered-data-store.scope.entry:read"],
111-
"conditional": []
112-
},
109+
"x-roblox-scopes": [
110+
{ "name": "universe.ordered-data-store.scope.entry:read" }
111+
],
113112
"x-roblox-cloud-api-operation-code-samples": [
114113
{
115114
"language": "curl",
@@ -119,7 +118,7 @@
119118
"x-roblox-rate-limits": {
120119
"description": "See [Throttling](../../../cloud/guides/data-store-api-handling#throttling)."
121120
},
122-
"x-roblox-replacements": [
121+
"x-roblox-alternatives": [
123122
{
124123
"url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries",
125124
"httpMethod": "GET"
@@ -209,10 +208,9 @@
209208
"roblox-api-key": ["Label.Write"]
210209
}
211210
],
212-
"x-roblox-scopes": {
213-
"required": ["universe.ordered-data-store.scope.entry:write"],
214-
"conditional": []
215-
},
211+
"x-roblox-scopes": [
212+
{ "name": "universe.ordered-data-store.scope.entry:write" }
213+
],
216214
"x-roblox-cloud-api-operation-code-samples": [
217215
{
218216
"language": "curl",
@@ -222,7 +220,7 @@
222220
"x-roblox-rate-limits": {
223221
"description": "See [Throttling](../../../cloud/guides/data-store-api-handling#throttling)."
224222
},
225-
"x-roblox-replacements": [
223+
"x-roblox-alternatives": [
226224
{
227225
"url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries",
228226
"httpMethod": "POST"
@@ -304,10 +302,9 @@
304302
"roblox-api-key": ["Label.Read"]
305303
}
306304
],
307-
"x-roblox-scopes": {
308-
"required": ["universe.ordered-data-store.scope.entry:read"],
309-
"conditional": []
310-
},
305+
"x-roblox-scopes": [
306+
{ "name": "universe.ordered-data-store.scope.entry:read" }
307+
],
311308
"x-roblox-cloud-api-operation-code-samples": [
312309
{
313310
"language": "curl",
@@ -317,7 +314,7 @@
317314
"x-roblox-rate-limits": {
318315
"description": "See [Throttling](../../../cloud/guides/data-store-api-handling#throttling)."
319316
},
320-
"x-roblox-replacements": [
317+
"x-roblox-alternatives": [
321318
{
322319
"url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}",
323320
"httpMethod": "GET"
@@ -390,10 +387,9 @@
390387
"roblox-api-key": ["Label.Write"]
391388
}
392389
],
393-
"x-roblox-scopes": {
394-
"required": ["universe.ordered-data-store.scope.entry:write"],
395-
"conditional": []
396-
},
390+
"x-roblox-scopes": [
391+
{ "name": "universe.ordered-data-store.scope.entry:write" }
392+
],
397393
"x-roblox-cloud-api-operation-code-samples": [
398394
{
399395
"language": "curl",
@@ -403,7 +399,7 @@
403399
"x-roblox-rate-limits": {
404400
"description": "See [Throttling](../../../cloud/guides/data-store-api-handling#throttling)."
405401
},
406-
"x-roblox-replacements": [
402+
"x-roblox-alternatives": [
407403
{
408404
"url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}",
409405
"httpMethod": "DELETE"
@@ -504,10 +500,9 @@
504500
"roblox-api-key": ["Label.Write"]
505501
}
506502
],
507-
"x-roblox-scopes": {
508-
"required": ["universe.ordered-data-store.scope.entry:write"],
509-
"conditional": []
510-
},
503+
"x-roblox-scopes": [
504+
{ "name": "universe.ordered-data-store.scope.entry:write" }
505+
],
511506
"x-roblox-cloud-api-operation-code-samples": [
512507
{
513508
"language": "curl",
@@ -517,7 +512,7 @@
517512
"x-roblox-rate-limits": {
518513
"description": "See [Throttling](../../../cloud/guides/data-store-api-handling#throttling)."
519514
},
520-
"x-roblox-replacements": [
515+
"x-roblox-alternatives": [
521516
{
522517
"url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}",
523518
"httpMethod": "PATCH"
@@ -609,10 +604,9 @@
609604
"roblox-api-key": ["Label.Write"]
610605
}
611606
],
612-
"x-roblox-scopes": {
613-
"required": ["universe.ordered-data-store.scope.entry:write"],
614-
"conditional": []
615-
},
607+
"x-roblox-scopes": [
608+
{ "name": "universe.ordered-data-store.scope.entry:write" }
609+
],
616610
"x-roblox-cloud-api-operation-code-samples": [
617611
{
618612
"language": "curl",
@@ -622,7 +616,7 @@
622616
"x-roblox-rate-limits": {
623617
"description": "See [Throttling](../../../cloud/guides/data-store-api-handling#throttling)."
624618
},
625-
"x-roblox-replacements": [
619+
"x-roblox-alternatives": [
626620
{
627621
"url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment",
628622
"httpMethod": "POST"

0 commit comments

Comments
 (0)