Skip to content

Commit dafe042

Browse files
github-actions[bot]github-actions[bot]
committed
sync: update documentation sources (2026-03-31 07:16 UTC)
1 parent 7915ae2 commit dafe042

20 files changed

Lines changed: 27983 additions & 31818 deletions

‎roblox/en-us/reference/cloud/cloud.docs.json‎

Lines changed: 179 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
"x-roblox-rate-limits": {
6464
"perApiKeyOwner": {
6565
"period": "MINUTE",
66-
"maxInPeriod": 150
66+
"maxInPeriod": 30
6767
},
6868
"perOauth2Authorization": {
6969
"period": "MINUTE",
@@ -132,7 +132,7 @@
132132
"x-roblox-rate-limits": {
133133
"perApiKeyOwner": {
134134
"period": "MINUTE",
135-
"maxInPeriod": 150
135+
"maxInPeriod": 30
136136
},
137137
"perOauth2Authorization": {
138138
"period": "MINUTE",
@@ -227,7 +227,7 @@
227227
"x-roblox-rate-limits": {
228228
"perApiKeyOwner": {
229229
"period": "MINUTE",
230-
"maxInPeriod": 150
230+
"maxInPeriod": 30
231231
},
232232
"perOauth2Authorization": {
233233
"period": "MINUTE",
@@ -1009,7 +1009,7 @@
10091009
"patch": {
10101010
"tags": ["Cloud"],
10111011
"summary": "Update Group Membership",
1012-
"description": "Updates the group membership for a particular group member. This action\nrequires the requester to be able to manage lower ranked members. Guest or\nOwner ranks cannot be assigned, and a requester cannot change their own\nrank.",
1012+
"description": "**Deprecated.** Use AssignGroupRole and UnassignGroupRole instead.\nUpdates the group membership for a particular group member. This action\nrequires the requester to be able to manage lower ranked members. Guest or\nOwner ranks cannot be assigned, and a requester cannot change their own\nrank.",
10131013
"operationId": "Cloud_UpdateGroupMembership",
10141014
"parameters": [
10151015
{
@@ -1093,6 +1093,146 @@
10931093
]
10941094
}
10951095
},
1096+
"/cloud/v2/groups/{group_id}/memberships/{membership_id}:assignRole": {
1097+
"post": {
1098+
"tags": ["Cloud"],
1099+
"summary": "Assign Role Group Membership",
1100+
"description": "Assigns a specific role to a user within a group. If the user already\nholds the specified role, no action is taken.",
1101+
"operationId": "Cloud_AssignRoleGroupMembership",
1102+
"parameters": [
1103+
{
1104+
"name": "group_id",
1105+
"in": "path",
1106+
"description": "The group ID.",
1107+
"required": true,
1108+
"schema": {
1109+
"type": "string"
1110+
}
1111+
},
1112+
{
1113+
"name": "membership_id",
1114+
"in": "path",
1115+
"description": "The membership ID.",
1116+
"required": true,
1117+
"schema": {
1118+
"type": "string"
1119+
}
1120+
}
1121+
],
1122+
"requestBody": {
1123+
"content": {
1124+
"application/json": {
1125+
"schema": {
1126+
"$ref": "#/components/schemas/AssignRoleGroupMembershipRequest"
1127+
}
1128+
}
1129+
},
1130+
"required": true
1131+
},
1132+
"responses": {
1133+
"200": {
1134+
"description": "OK",
1135+
"content": {
1136+
"application/json": {
1137+
"schema": {
1138+
"$ref": "#/components/schemas/GroupMembership"
1139+
}
1140+
}
1141+
}
1142+
}
1143+
},
1144+
"x-visibility": "BETA",
1145+
"x-roblox-engine-usability": {
1146+
"apiKeyWithHttpService": true
1147+
},
1148+
"x-roblox-scopes": [
1149+
{
1150+
"name": "group:write"
1151+
}
1152+
],
1153+
"x-roblox-docs": {
1154+
"category": "Users and groups",
1155+
"methodProperties": {
1156+
"scopes": ["group:write"]
1157+
},
1158+
"resource": {
1159+
"$ref": "#/components/schemas/GroupMembership",
1160+
"name": "GroupMembership"
1161+
}
1162+
},
1163+
"x-roblox-stability": "BETA"
1164+
}
1165+
},
1166+
"/cloud/v2/groups/{group_id}/memberships/{membership_id}:unassignRole": {
1167+
"post": {
1168+
"tags": ["Cloud"],
1169+
"summary": "Unassign Role Group Membership",
1170+
"description": "Unassigns a specific role from a user within a group. If the user does\nnot hold the specified role, no action is taken.",
1171+
"operationId": "Cloud_UnassignRoleGroupMembership",
1172+
"parameters": [
1173+
{
1174+
"name": "group_id",
1175+
"in": "path",
1176+
"description": "The group ID.",
1177+
"required": true,
1178+
"schema": {
1179+
"type": "string"
1180+
}
1181+
},
1182+
{
1183+
"name": "membership_id",
1184+
"in": "path",
1185+
"description": "The membership ID.",
1186+
"required": true,
1187+
"schema": {
1188+
"type": "string"
1189+
}
1190+
}
1191+
],
1192+
"requestBody": {
1193+
"content": {
1194+
"application/json": {
1195+
"schema": {
1196+
"$ref": "#/components/schemas/UnassignRoleGroupMembershipRequest"
1197+
}
1198+
}
1199+
},
1200+
"required": true
1201+
},
1202+
"responses": {
1203+
"200": {
1204+
"description": "OK",
1205+
"content": {
1206+
"application/json": {
1207+
"schema": {
1208+
"$ref": "#/components/schemas/GroupMembership"
1209+
}
1210+
}
1211+
}
1212+
}
1213+
},
1214+
"x-visibility": "BETA",
1215+
"x-roblox-engine-usability": {
1216+
"apiKeyWithHttpService": true
1217+
},
1218+
"x-roblox-scopes": [
1219+
{
1220+
"name": "group:write"
1221+
}
1222+
],
1223+
"x-roblox-docs": {
1224+
"category": "Users and groups",
1225+
"methodProperties": {
1226+
"scopes": ["group:write"]
1227+
},
1228+
"resource": {
1229+
"$ref": "#/components/schemas/GroupMembership",
1230+
"name": "GroupMembership"
1231+
}
1232+
},
1233+
"x-roblox-stability": "BETA"
1234+
}
1235+
},
10961236
"/cloud/v2/groups/{group_id}/roles": {
10971237
"get": {
10981238
"tags": ["Cloud"],
@@ -7281,6 +7421,18 @@
72817421
},
72827422
"x-resource": true
72837423
},
7424+
"AssignRoleGroupMembershipRequest": {
7425+
"required": ["role"],
7426+
"type": "object",
7427+
"properties": {
7428+
"role": {
7429+
"example": "groups/123/roles/456",
7430+
"type": "string",
7431+
"description": "The resource path of the role to assign.\n\nFormat: `groups/{group_id}/roles/{group_role_id}`"
7432+
}
7433+
},
7434+
"description": "Assigns a role to the specified group membership."
7435+
},
72847436
"ContentMessage": {
72857437
"type": "object",
72867438
"properties": {
@@ -7998,7 +8150,16 @@
79988150
"role": {
79998151
"example": "groups/7/roles/99513316",
80008152
"type": "string",
8001-
"description": "The resource path for the role of the group member."
8153+
"description": "The resource path of the member's highest-ranked role.\nWhen the member holds multiple roles, this reflects only the\nhighest-ranked one. Prefer using the `roles` field, which always\ncontains the complete set of assigned roles."
8154+
},
8155+
"roles": {
8156+
"readOnly": true,
8157+
"example": "groups/7/roles/99513316",
8158+
"type": "array",
8159+
"items": {
8160+
"type": "string"
8161+
},
8162+
"description": "The resource paths of all roles assigned to the group member.\nThis is the recommended field for reading a member's roles, as it\nalways contains the complete set of roles held by the member."
80028163
}
80038164
},
80048165
"description": "A membership to a group. A user ID can be used in place of a membership ID.",
@@ -9573,7 +9734,7 @@
95739734
"ROBLOX_CREDIT"
95749735
],
95759736
"type": "string",
9576-
"description": "The payment provider used to purchase the subscription.\n\nPossible values:\n\n | Value | Description |\n | --- | --- |\n | PAYMENT_PROVIDER_UNSPECIFIED | The payment provider is unspecified. |\n | STRIPE | The subscription was purchased using Stripe. |\n | APPLE | The subscription was purchased using Apple. |\n | GOOGLE | The subscription was purchased using Google. |\n | ROBLOX_CREDIT | The subscription was purchased using Roblox Credit. |",
9737+
"description": "The payment provider used to purchase the subscription.\n\nPossible values:\n\n | Value | Description |\n | --- | --- |\n | PAYMENT_PROVIDER_UNSPECIFIED | The payment provider is unspecified. For fiat currency subscriptions, this indicates an error. For Robux subscriptions, this is expected as Robux transactions do not use an external payment provider. |\n | STRIPE | The subscription was purchased using Stripe. |\n | APPLE | The subscription was purchased using Apple. |\n | GOOGLE | The subscription was purchased using Google. |\n | ROBLOX_CREDIT | The subscription was purchased using Roblox Credit. |",
95779738
"format": "enum"
95789739
},
95799740
"user": {
@@ -9658,6 +9819,18 @@
96589819
},
96599820
"description": "Contains the detected or specified source language code and a map of\nrequested translations, where each key is a language code and the value is\nthe translated text."
96609821
},
9822+
"UnassignRoleGroupMembershipRequest": {
9823+
"required": ["role"],
9824+
"type": "object",
9825+
"properties": {
9826+
"role": {
9827+
"example": "groups/123/roles/456",
9828+
"type": "string",
9829+
"description": "The resource path of the role to unassign.\n\nFormat: `groups/{group_id}/roles/{group_role_id}`"
9830+
}
9831+
},
9832+
"description": "Unassigns a role from the specified group membership."
9833+
},
96619834
"UndeleteDataStoreRequest": {
96629835
"type": "object",
96639836
"properties": {},

0 commit comments

Comments
 (0)