|
1957 | 1957 | "tags": [ |
1958 | 1958 | "Cloud" |
1959 | 1959 | ], |
1960 | | - "description": "Takes a new snapshot of the data stores in an experience.\n\n After a snapshot, the next write to every key in the experience will\n create a versioned backup of the previous data, regardless of the time of\n the last write.\n\n In effect, all data current at the time of the snapshot is guaranteed to be\n available as a versioned backup for at least 30 days.\n\n Snapshots can be taken once per UTC day, per experience. If the latest\n snapshot was taken within the same UTC day, this operation is a no-op and\n the time of the latest snapshot will be returned.\n\n For more information on using snapshots, see the [Data\n Stores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots)\n Engine guide.", |
| 1960 | + "description": "Takes a new snapshot of the data stores in an experience.\n\n After a snapshot, the next write to every key in the experience\n creates a versioned backup of the previous data, regardless of the time of\n the last write.\n\n In effect, all data current at the time of the snapshot is guaranteed to be\n available as a versioned backup for at least 30 days.\n\n Snapshots can be taken once per UTC day, per experience. If the latest\n snapshot was taken within the same UTC day, this operation is a no-op and\n the time of the latest snapshot will be returned.\n\n For more information on using snapshots, see the [Data\n Stores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots)\n Engine guide.", |
1961 | 1961 | "operationId": "Cloud_SnapshotDataStores", |
1962 | 1962 | "parameters": [ |
1963 | 1963 | { |
|
5307 | 5307 | "tags": [ |
5308 | 5308 | "Cloud" |
5309 | 5309 | ], |
5310 | | - "description": "Gets a user's basic and advanced information.\n\n To access a user's public information, no additional scopes are required.\n\n To access a user's premium or verification status, you need the following\n scopes:\n * user.advanced.read\n\n To access a user's social account information, you need the following\n scopes:\n * user.social.read", |
| 5310 | + "description": "Gets a user's basic and advanced information.\n\n To access a user's public information, no additional scopes are required.\n\n To access a user's verification status, you need the following scopes:\n * user.advanced.read\n\n To access a user's social account information, you need the following\n scopes:\n * user.social.read", |
5311 | 5311 | "operationId": "Cloud_GetUser", |
5312 | 5312 | "parameters": [ |
5313 | 5313 | { |
|
7522 | 7522 | "tags": [ |
7523 | 7523 | "Cloud" |
7524 | 7524 | ], |
7525 | | - "description": "Takes a new snapshot of the data stores in an experience.\n\n After a snapshot, the next write to every key in the experience will\n create a versioned backup of the previous data, regardless of the time of\n the last write.\n\n In effect, all data current at the time of the snapshot is guaranteed to be\n available as a versioned backup for at least 30 days.\n\n Snapshots can be taken once per UTC day, per experience. If the latest\n snapshot was taken within the same UTC day, this operation is a no-op and\n the time of the latest snapshot will be returned.\n\n For more information on using snapshots, see the [Data\n Stores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots)\n Engine guide.", |
| 7525 | + "description": "Takes a new snapshot of the data stores in an experience.\n\n After a snapshot, the next write to every key in the experience\n creates a versioned backup of the previous data, regardless of the time of\n the last write.\n\n In effect, all data current at the time of the snapshot is guaranteed to be\n available as a versioned backup for at least 30 days.\n\n Snapshots can be taken once per UTC day, per experience. If the latest\n snapshot was taken within the same UTC day, this operation is a no-op and\n the time of the latest snapshot will be returned.\n\n For more information on using snapshots, see the [Data\n Stores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots)\n Engine guide.", |
7526 | 7526 | "operationId": "Cloud_SnapshotDataStores", |
7527 | 7527 | "parameters": [ |
7528 | 7528 | { |
|
10872 | 10872 | "tags": [ |
10873 | 10873 | "Cloud" |
10874 | 10874 | ], |
10875 | | - "description": "Gets a user's basic and advanced information.\n\n To access a user's public information, no additional scopes are required.\n\n To access a user's premium or verification status, you need the following\n scopes:\n * user.advanced.read\n\n To access a user's social account information, you need the following\n scopes:\n * user.social.read", |
| 10875 | + "description": "Gets a user's basic and advanced information.\n\n To access a user's public information, no additional scopes are required.\n\n To access a user's verification status, you need the following scopes:\n * user.advanced.read\n\n To access a user's social account information, you need the following\n scopes:\n * user.social.read", |
10876 | 10876 | "operationId": "Cloud_GetUser", |
10877 | 10877 | "parameters": [ |
10878 | 10878 | { |
|
11147 | 11147 | "AcceptGroupJoinRequestRequest": { |
11148 | 11148 | "type": "object", |
11149 | 11149 | "properties": {}, |
11150 | | - "description": "A join request id." |
| 11150 | + "description": "A join request ID." |
11151 | 11151 | }, |
11152 | 11152 | "AssetQuota": { |
11153 | 11153 | "type": "object", |
|
12873 | 12873 | "DeclineGroupJoinRequestRequest": { |
12874 | 12874 | "type": "object", |
12875 | 12875 | "properties": {}, |
12876 | | - "description": "A join request id." |
| 12876 | + "description": "A join request ID." |
12877 | 12877 | }, |
12878 | 12878 | "DeveloperProduct": { |
12879 | 12879 | "required": [ |
@@ -12990,12 +12990,12 @@ |
12990 | 12990 | "FlushMemoryStoreRequest": { |
12991 | 12991 | "type": "object", |
12992 | 12992 | "properties": {}, |
12993 | | - "description": "Asynchronously flush all data structures in the universe." |
| 12993 | + "description": "Request body not required." |
12994 | 12994 | }, |
12995 | 12995 | "FlushMemoryStoreResponse": { |
12996 | 12996 | "type": "object", |
12997 | 12997 | "properties": {}, |
12998 | | - "description": "Includes the path to the flush operation and a boolean for whether or not the\n operation completed." |
| 12998 | + "description": "Returns a FlushMemoryStoreResponse object." |
12999 | 12999 | }, |
13000 | 13000 | "GamePass": { |
13001 | 13001 | "type": "object", |
|
13077 | 13077 | "description": "URI for the generated thumbnail." |
13078 | 13078 | } |
13079 | 13079 | }, |
13080 | | - "description": "Returns the URI for the generated thumbnail." |
| 13080 | + "description": "Returns the URL for the user's avatar thumbnail." |
13081 | 13081 | }, |
13082 | 13082 | "GetInstanceMetadata": { |
13083 | 13083 | "type": "object", |
@@ -13663,23 +13663,16 @@ |
13663 | 13663 | "description": "An arbitrary set of attributes associated with the entry.\n\n If this is not provided, existing attributes are cleared." |
13664 | 13664 | } |
13665 | 13665 | }, |
13666 | | - "description": "Increments entry value.\n\n If the value is not numeric, this request fails.", |
| 13666 | + "description": "Increments the entry value.\n\n If the value is not numeric, this request fails.", |
13667 | 13667 | "x-oneOf": { |
13668 | 13668 | "Amount": [ |
13669 | 13669 | "amount" |
13670 | 13670 | ] |
13671 | 13671 | } |
13672 | 13672 | }, |
13673 | 13673 | "IncrementOrderedDataStoreEntryRequest": { |
13674 | | - "required": [ |
13675 | | - "path" |
13676 | | - ], |
13677 | 13674 | "type": "object", |
13678 | 13675 | "properties": { |
13679 | | - "path": { |
13680 | | - "type": "string", |
13681 | | - "description": "The name of the ordered data store entry.\n\n Format:\n universes/{universe}/ordered-data-stores/{ordered_data_store}/scopes/{ordered_data_store_scope}/entries/{ordered_data_store_entry}" |
13682 | | - }, |
13683 | 13676 | "amount": { |
13684 | 13677 | "type": "number", |
13685 | 13678 | "description": "The amount by which to increment the entry value. Both the existing value\n and the increment amount must be integers.", |
|
14117 | 14110 | "description": "A token, which can be sent as `page_token` to retrieve the next page.\n If this field is omitted, there are no subsequent pages." |
14118 | 14111 | } |
14119 | 14112 | }, |
14120 | | - "description": "Returns children instances" |
| 14113 | + "description": "Returns a list of the instance's children." |
14121 | 14114 | }, |
14122 | 14115 | "ListInventoryItemsResponse": { |
14123 | 14116 | "type": "object", |
|
14309 | 14302 | "description": "Present when the task execution succeeds. Contains the output of the\n execution." |
14310 | 14303 | } |
14311 | 14304 | }, |
14312 | | - "description": "A `LuauExecutionSessionTask` (\"task\" for short) executes a given Luau script\n in the context of a specific version of a place.\n\n In a task, physics simulation does not run. Server and local scripts within\n the place also do not automatically run.\n\n The script may access and update the data model of the place, including\n invoking any module scripts. However, data model changes are local to the\n task and cannot be persisted.\n\n The following Engine APIs are disallowed in order to prevent accidental\n modification of production data:\n\n * `Class.AssetService:CreatePlaceAsync()`\n * `Class.AssetService:SavePlaceAsync()`\n * `Class.DataStoreService:GetDataStore()`\n * `Class.DataStoreService:GetGlobalDataStore()`\n * `Class.DataStoreService:GetOrderedDataStore()`\n * `Class.MemoryStoreService:GetHashMap()`\n * `Class.MemoryStoreService:GetQueue()`\n * `Class.MemoryStoreService:GetSortedMap()`\n * `Class.Players:BanAsync()`\n * `Class.Players:UnbanAsync()`\n * `Class.Players:GetBanHistoryAsync()`\n * `Class.HttpService:GetAsync()`\n * `Class.HttpService:PostAsync()`\n * `Class.HttpService:RequestAsync()`\n * `Class.MessagingService:PublishAsync()`\n * `Class.MessagingService:SubscribeAsync()`\n * `Class.DataModel:SavePlace()`\n\n Scripts can be up to 4 MB in size and run for up to 30 seconds. Scripts that\n run for longer than 30 seconds terminate with an error.\n\n Scripts are executed as-is and do not need to be wrapped in a function.\n\n Scripts can return values (using the Luau `return` keyword). Return values\n are serialized to JSON and can be retrieved with the `Get\n LuauExecutionSessionTask` API after the task completes. The total size of the\n return values after JSON serialization must not exceed 4 MB. If the limit is\n exceeded, the task terminates with an error.\n\n If the script raises an unhandled error, the task terminates. The error\n information can be retrieved with the `GetLuauExecutionSessionTask` API.\n\n Standard output (generated by the Luau `print` function) can be retrieved\n with the `ListLuauExecutionSessionTaskLogs` method after the task completes.\n A maximum of 450 KB of logs are retained. If the amount of logs exceeds the\n limit, older logs are discarded.\n\n Information about a task is retained for 24 hours after task completion.\n\n At most two incomplete tasks are allowed per place. Attempting to create a\n third task while the first two are incomplete results in a HTTP 429 response.", |
| 14305 | + "description": "A `LuauExecutionSessionTask` (\"task\" for short) executes a given Luau script\n in the context of a specific version of a place.\n\n In a task, physics simulation does not run. Server and local scripts within\n the place also do not automatically run.\n\n The script may access and update the data model of the place, including\n invoking any module scripts. However, data model changes are local to the\n task and cannot be persisted.\n\n The following Engine APIs are disallowed in order to prevent accidental\n modification of production data:\n\n * `Class.AssetService:CreatePlaceAsync()`\n * `Class.AssetService:SavePlaceAsync()`\n * `Class.DataStoreService:GetDataStore()`\n * `Class.DataStoreService:GetGlobalDataStore()`\n * `Class.DataStoreService:GetOrderedDataStore()`\n * `Class.MemoryStoreService:GetHashMap()`\n * `Class.MemoryStoreService:GetQueue()`\n * `Class.MemoryStoreService:GetSortedMap()`\n * `Class.Players:BanAsync()`\n * `Class.Players:UnbanAsync()`\n * `Class.Players:GetBanHistoryAsync()`\n * `Class.HttpService:GetAsync()`\n * `Class.HttpService:PostAsync()`\n * `Class.HttpService:RequestAsync()`\n * `Class.MessagingService:PublishAsync()`\n * `Class.MessagingService:SubscribeAsync()`\n * `Class.DataModel:SavePlace()`\n\n Scripts can be up to 4 MB in size and run for up to 30 seconds. Scripts that\n run for longer than 30 seconds terminate with an error.\n\n Scripts are executed as-is and do not need to be wrapped in a function.\n\n Scripts can return values (using the Luau `return` keyword). Return values\n are serialized to JSON and can be retrieved with the `Get\n LuauExecutionSessionTask` API after the task completes. The total size of the\n return values after JSON serialization must not exceed 4 MB. If the limit is\n exceeded, the task terminates with an error.\n\n If the script raises an unhandled error, the task terminates. The error\n information can be retrieved with the `GetLuauExecutionSessionTask` API.\n\n Standard output (generated by the Luau `print` function) can be retrieved\n with the `ListLuauExecutionSessionTaskLogs` method after the task completes.\n A maximum of 450 KB of logs are retained. If the amount of logs exceeds the\n limit, older logs are discarded.\n\n Information about a task is retained for 24 hours after task completion.\n\n At most ten incomplete tasks are allowed per place. Attempting to create more\n tasks while the first ten are incomplete results in a HTTP 429 response.", |
14313 | 14306 | "x-resource": true, |
14314 | 14307 | "x-oneOf": { |
14315 | 14308 | "result": [ |
|
14781 | 14774 | "description": "The items read from the queue" |
14782 | 14775 | } |
14783 | 14776 | }, |
14784 | | - "description": "Returns the specified number of items at the front of the queue" |
| 14777 | + "description": "Returns the specified number of items at the front of the queue." |
14785 | 14778 | }, |
14786 | 14779 | "RestartUniverseServersRequest": { |
14787 | 14780 | "type": "object", |
|
14873 | 14866 | } |
14874 | 14867 | } |
14875 | 14868 | }, |
14876 | | - "description": "Returns whether a new snapshot was taken and the time of the latest\n snapshot after the operation (regardless of whether a new snapshot was\n taken).", |
| 14869 | + "description": "Returns whether a new snapshot was taken and the time of the latest snapshot\n after the operation (regardless of whether a new snapshot was taken).", |
14877 | 14870 | "x-oneOf": { |
14878 | 14871 | "NewSnapshotTaken": [ |
14879 | 14872 | "newSnapshotTaken" |
|
15694 | 15687 | "premium": { |
15695 | 15688 | "readOnly": true, |
15696 | 15689 | "type": "boolean", |
15697 | | - "description": "Whether the user is a premium user.\n\n To access this data, you need an API key / OAuth token with the following\n scope: user.advanced:read", |
| 15690 | + "description": "Whether the user is a premium user.", |
15698 | 15691 | "x-example-values": { |
15699 | 15692 | "exampleValues": [ |
15700 | 15693 | true |
|
0 commit comments