Skip to content

Commit 98242d6

Browse files
update Open Source Docs from Roblox internal teams
1 parent b11fd21 commit 98242d6

File tree

7 files changed

+31
-10
lines changed

7 files changed

+31
-10
lines changed

content/common/navigation/cloud/reference.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,6 @@ navigation:
9090
- heading: Open Cloud API Reference
9191
- title: Cloud
9292
section:
93-
- title: Toolbox service
94-
path: /cloud/api/toolbox-service
9593
- title: Asset delivery
9694
path: /cloud/api/asset-delivery
9795
- title: Badges
@@ -108,6 +106,8 @@ navigation:
108106
path: /cloud/api/localization
109107
- title: Publish
110108
path: /cloud/api/publish
109+
- title: Toolbox service
110+
path: /cloud/api/toolbox-service
111111
- title: Open Cloud v2
112112
section:
113113
- title: All Cloud API # doesn't show anywhere

content/en-us/art/validation-errors.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ The following is a table of all possible validation error codes, as well as any
9393
<td>Failed to execute similarity mesh vertex check for `%s`. Make sure mesh exists and try again.</td>
9494
<td></td>
9595
</tr>
96-
<tr>
96+
<tr id = "cageDensity">
9797
<td>`%s` has `%d` % of vertices too close to each other. Please edit the vertices to have at most `%d` % coincident or close to one another.</td>
9898
<td>Your accessory cage has too many vertices close together. This may cause the system to treat them as repeated vertices, or zero area triangles. You need to [edit and move](../art/accessories/caging-best-practices.md) the vertices away from each other in the region(s) they are almost coincident.</td>
9999
</tr>
@@ -136,7 +136,7 @@ The following is a table of all possible validation error codes, as well as any
136136
<td>WrapTarget `%s` found under `%s` has a CageOrigin position greater than %. You need to set `CageOrigin.Position` to `0`,`0`,`0`.</td>
137137
<td>Cage origin must be zero to properly align with its corresponding body or accessory.</td>
138138
</tr>
139-
<tr>
139+
<tr id = "cageMeshDistance">
140140
<td>Average distance between outer cage to mesh is too high. Mesh seems to be outside of the outer cage.<br/><br/>Average distance between outer cage to mesh is too high %. Make adjustment to cage to fit the mesh better.</td>
141141
<td>The outer cage is too far away from its corresponding body or accessory model mesh. You need to [remodel the outer cage](../art/accessories/caging-best-practices.md) and bring its vertices closer to the model mesh.</td>
142142
</tr>
@@ -192,7 +192,7 @@ The following is a table of all possible validation error codes, as well as any
192192
<td>Failed to execute cage relevancy detection for `%s`. Make sure the cage mesh exists and try again.</td>
193193
<td></td>
194194
</tr>
195-
<tr>
195+
<tr id = "cageRelevancy">
196196
<td>Validation detected `%d` % of the outer cage edits do not cover the accessory. Make sure you are moving the outer cage only where needed.</td>
197197
<td>This validation has detected that you moved out many vertices of your outer cage that weren't in the same region as your model geometry. <br/><br/>You need to verify your outer cage is modified only enough to envelop the accessory model mesh, and stays consistent with the inner cage everywhere else.</td>
198198
</tr>
@@ -204,7 +204,7 @@ The following is a table of all possible validation error codes, as well as any
204204
<td>Failed to load UVs for Inner cage of `%s`. Make sure the UV map exists and try again.</td>
205205
<td></td>
206206
</tr>
207-
<tr>
207+
<tr id = "cageExtraUvs">
208208
<td>There are `%d` UV values in `%s` cage that do not belong to the template. Please correct the cage UV.</td>
209209
<td>The cage has an invalid UV map, possibly from using an old or third-party cage. Use the UV map and model mesh templates provided in the [official documentation resources](../avatar/resources.md#project-files).</td>
210210
</tr>
@@ -407,7 +407,7 @@ The following is a table of all possible validation error codes, as well as any
407407
<td>Failed to execute render mesh inside outer mesh check for `%s` and `%s`. Make sure the meshes exists and try again.</td>
408408
<td></td>
409409
</tr>
410-
<tr>
410+
<tr id ="cageInsideMesh">
411411
<td>Validation detected `%d`% of the accessory is outside its outer cage. Make adjustments to have more of the accessory placed between the cages.</td>
412412
<td>The outer cage needs to envelop the model mesh of its corresponding accessory. This check has detected a large portion of the model mesh is outside its outer cage. You need to edit the model and/or the cage to fix this issue.</td>
413413
</tr>
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/reference/cloud/cloud.docs.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7444,6 +7444,21 @@
74447444
"output": {
74457445
"$ref": "#/components/schemas/LuauExecutionSessionTask_Output",
74467446
"description": "Present when the task execution succeeds. Contains the output of the\nexecution."
7447+
},
7448+
"binaryInput": {
7449+
"type": "string",
7450+
"description": "Resource path of the binary input to this task. See the documentation for\nthe\n`LuauExecutionSessionTaskBinaryInput` resource for usage details."
7451+
},
7452+
"enableBinaryOutput": {
7453+
"example": true,
7454+
"type": "boolean",
7455+
"description": "If set to true, allows the task to output a large binary object in addition\nto standard return values.\n\nIf `enable_binary_output` is set to true, the task script must return a\n`LuauExecutionTaskOutput` (or equivalent table) and no other return values.\n\nBelow is example code for doing so:\n\n```luau\nlocal buf: buffer = buffer.create(10)\nlocal result: LuauExecutionTaskOutput = {\n BinaryOutput = buf,\n ReturnValues = { \"hello world\", 123 }\n}\nreturn result\n```\n\nThe `BinaryOutput` buffer must be no larger than 256 MiB in size.\n\nThe `ReturnValues` array, if given, will be serialized to JSON and made\navailable in the `output` field of the `LuauExecutionSessionTask` resource,\nsimilar to regular return values when not using `enable_binary_output`.\n\nThe binary output can be fetched from the URI in the `binaryOutputUri`\nfield after the task completes. The `binaryOutputUri` is valid for 15\nminutes after task completion.",
7456+
"x-immutable": true
7457+
},
7458+
"binaryOutputUri": {
7459+
"readOnly": true,
7460+
"type": "string",
7461+
"description": "URI for the binary output of this task. See the `enableBinaryOutput` field\nfor usage details."
74477462
}
74487463
},
74497464
"description": "A `LuauExecutionSessionTask` (\"task\" for short) executes a given Luau script\nin the context of a specific version of a place.\n\nIn a task, physics simulation does not run. Server and local scripts within\nthe place also do not automatically run.\n\nThe script may access and update the data model of the place, including\ninvoking any module scripts. However, data model changes are local to the\ntask and cannot be persisted.\n\nThe script can also invoke engine APIs that read and/or modify data stored in\nthe cloud, such as those for DataStores. Exercise caution when using these\nAPIs.\n\nScripts can be up to 4 MB in size and run for up to 5 minutes. Scripts that\nrun for longer than the time limit terminate with an error.\n\nScripts are executed as-is and do not need to be wrapped in a function.\n\nScripts can return values (using the Luau `return` keyword). Return values\nare serialized to JSON and can be retrieved with the `Get\nLuauExecutionSessionTask` API after the task completes. The total size of the\nreturn values after JSON serialization must not exceed 4 MB. If the limit is\nexceeded, the task terminates with an error.\n\nIf the script raises an unhandled error, the task terminates. The error\ninformation can be retrieved with the `GetLuauExecutionSessionTask` API.\n\nStandard output (generated by the Luau `print` function) can be retrieved\nwith the `ListLuauExecutionSessionTaskLogs` method after the task completes.\nA maximum of 450 KB of logs are retained. If the amount of logs exceeds the\nlimit, older logs are discarded.\n\nInformation about a task is retained for 24 hours after task completion.\n\nAt most ten incomplete tasks are allowed per place. Attempting to create more\ntasks while the first ten are incomplete results in a HTTP 429 response.",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@
324324
},
325325
"delete": {
326326
"tags": ["OrderedDataStores"],
327-
"description": "Deletes the specified entry.",
327+
"description": "Deletes the specified entry. Unlike standard data stores, which mark entries for deletion, ordered data store entries are deleted immediately.",
328328
"operationId": "OrderedDataStores_DeleteEntry",
329329
"x-roblox-cloud-api-operation-name": "Delete",
330330
"x-roblox-stability": "BETA",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@
121121
"get": {
122122
"tags": ["Entries"],
123123
"summary": "List entries",
124-
"description": "Returns a list of entry keys within a data store.",
124+
"description": "Returns a list of entry keys within a data store.\n\n Entries marked deleted with a tombstone version are still included in the response if they have yet to be permanently deleted.",
125125
"operationId": "Entries_ListKeysAsync",
126126
"x-roblox-cloud-api-operation-name": "List Entries",
127127
"x-roblox-stability": "BETA",
@@ -257,7 +257,7 @@
257257
"get": {
258258
"tags": ["Entries"],
259259
"summary": "Get entry.",
260-
"description": "Returns the value and metadata associated with an entry.\n\nMetadata can be found in the response headers like the following:\n```text\ncontent-md5: zuYxEhwuySMv0i8CitXImw==\nroblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01\nroblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00\nroblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00\nroblox-entry-attributes: { \"myAttribute\": \"myValue\" }\nroblox-entry-userids: [1, 2, 3]\n```\n\n| Header | Description |\n|---|---| \n| `content-md5` | The base-64 encoded MD5 checksum of the content. See [Content-MD5](../../../cloud/guides/data-store-api-handling.md#content-md5). |\n| `roblox-entry-version` | The version of the returned entry. |\n| `roblox-entry-created-time` | The time at which the entry was created. |\n| `roblox-entry-version-created-time` | The time at which this particular version was created. |\n| `roblox-entry-attributes` | Attributes tagged with the entry. Serialized JSON map object. |\n| `roblox-entry-userids` | Comma-separated list of Roblox user IDs tagged with the entry. |\n",
260+
"description": "Returns the value and metadata associated with an entry.\n\nEntries marked deleted with a tombstone version will return 404 Not Found.\n\nMetadata can be found in the response headers like the following:\n```text\ncontent-md5: zuYxEhwuySMv0i8CitXImw==\nroblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01\nroblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00\nroblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00\nroblox-entry-attributes: { \"myAttribute\": \"myValue\" }\nroblox-entry-userids: [1, 2, 3]\n```\n\n| Header | Description |\n|---|---| \n| `content-md5` | The base-64 encoded MD5 checksum of the content. See [Content-MD5](../../../cloud/guides/data-store-api-handling.md#content-md5). |\n| `roblox-entry-version` | The version of the returned entry. |\n| `roblox-entry-created-time` | The time at which the entry was created. |\n| `roblox-entry-version-created-time` | The time at which this particular version was created. |\n| `roblox-entry-attributes` | Attributes tagged with the entry. Serialized JSON map object. |\n| `roblox-entry-userids` | Comma-separated list of Roblox user IDs tagged with the entry. |\n",
261261
"operationId": "Entries_GetEntryAsync",
262262
"x-roblox-cloud-api-operation-name": "Get Entry",
263263
"x-roblox-stability": "BETA",

0 commit comments

Comments
 (0)