From 48933cdd8dce17eff405f912be4e32ff1c313590 Mon Sep 17 00:00:00 2001 From: "rbx-open-source-docs[bot]" <138828531+rbx-open-source-docs[bot]@users.noreply.github.com> Date: Thu, 12 Dec 2024 22:27:51 +0000 Subject: [PATCH] update Open Source Docs from Roblox internal teams --- .../common/navigation/cloud/reference.yaml | 2 + content/en-us/cloud/open-cloud/index.md | 2 +- content/en-us/cloud/reference/index.md | 1 + content/en-us/cloud/reference/openapi.md | 65 ++++ .../production/promotion/referral-system.md | 6 +- content/en-us/reference/cloud/README.md | 2 +- content/en-us/reference/cloud/assets/v1.json | 226 ++++++----- content/en-us/reference/cloud/cloud.docs.json | 344 ++++++++--------- .../cloud/datastores-api/ordered-v1.json | 63 ++-- .../reference/cloud/datastores-api/v1.json | 351 +++++------------- .../reference/cloud/messaging-service/v1.json | 20 + .../reference/cloud/universes-api/v1.json | 15 +- .../en-us/reference/engine/classes/Stats.yaml | 14 +- tools/checks/utils/allowedHttpLinks.txt | 10 + 14 files changed, 551 insertions(+), 570 deletions(-) create mode 100644 content/en-us/cloud/reference/openapi.md diff --git a/content/common/navigation/cloud/reference.yaml b/content/common/navigation/cloud/reference.yaml index 17fb4d838..966d33cd6 100644 --- a/content/common/navigation/cloud/reference.yaml +++ b/content/common/navigation/cloud/reference.yaml @@ -10,6 +10,8 @@ navigation: path: /cloud/reference/errors - title: OAuth 2.0 path: /cloud/reference/oauth2 + - title: OpenAPI Descriptions + path: /cloud/reference/openapi - heading: v2 Resources - title: All Cloud API path: /cloud/reference diff --git a/content/en-us/cloud/open-cloud/index.md b/content/en-us/cloud/open-cloud/index.md index ba89d4213..281de3816 100644 --- a/content/en-us/cloud/open-cloud/index.md +++ b/content/en-us/cloud/open-cloud/index.md @@ -28,6 +28,6 @@ The legacy APIs, no matter which types of authentication they support, can incor See the documentation for how to use [API keys](api-keys.md) or [OAuth 2.0](oauth2-overview.md). API keys are the easiest way to get started. -1. Use a tool like [Postman](https://www.postman.com) or the [OAuth 2.0 sample app](oauth2-sample.md) to test API calls. +1. Test API calls using tools like [Postman](https://www.postman.com) with [OpenAPI descriptions](../reference/openapi.md) and the [OAuth 2.0 sample app](oauth2-sample.md). 1. Review the [resource guides](experience-notifications.md) for end-to-end walkthroughs of using certain APIs. 1. See the Open Cloud [reference documentation](../reference/index.md) for the full list of v1 and v2 resources, [common API patterns](../reference/patterns.md), and [types](../reference/types.md). diff --git a/content/en-us/cloud/reference/index.md b/content/en-us/cloud/reference/index.md index 8b19f71ad..dadd5cf0f 100644 --- a/content/en-us/cloud/reference/index.md +++ b/content/en-us/cloud/reference/index.md @@ -11,5 +11,6 @@ The **Common Components** section of the reference documentation includes concep - [Patterns](../../cloud/reference/patterns.md) - Special considerations and patterns for making requests and handling responses. - [Types](../../cloud/reference/types.md) - How to handle common types used by Open Cloud in requests and responses. - [Errors](../../cloud/reference/errors.md) - Handling errors when working with resources. +- [OpenAPI Descriptions](../../cloud/reference/openapi.md) - Streamline development with OpenAPI descriptions of Open Cloud APIs. Each page in the **Resources** section represents a resource and includes all available operations for that resource. diff --git a/content/en-us/cloud/reference/openapi.md b/content/en-us/cloud/reference/openapi.md new file mode 100644 index 000000000..9ade6b44b --- /dev/null +++ b/content/en-us/cloud/reference/openapi.md @@ -0,0 +1,65 @@ +--- +title: OpenAPI Descriptions +description: Provides links to the Open Cloud JSON files that are compliant to the OpenAPI Specification, explains their use cases, and outlines additional information. +--- + +The reference pages in the **Resources** section are rendered from JSON files that are [OpenAPI descriptions](https://learn.openapis.org/glossary.html). These files use [version 3.0.4](https://spec.openapis.org/oas/v3.0.4) of the OpenAPI specification. + +These files are open source and can be used with tools like the [Swagger Editor](https://editor.swagger.io/) and [Postman](https://www.postman.com/) to test API calls and help streamline development. + +These OpenAPI descriptions are still under active development and may contain issues. The pages under the **Resources** section are the official reference. + +## OpenAPI Description Files + +OpenAPI description files are available at the following locations within the [creator-docs](https://github.com/Roblox/creator-docs/tree/main/content/en-us/reference/cloud) repository: + +```text +# All V2 Resources +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/cloud.docs.json + +# V1 Assets +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/assets/v1.json + +# V1 Ordered Data Stores +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/ordered-v1.json + +# V1 Standard Data Stores +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/v1.json + +# V1 Messaging +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/messaging-service/v1.json + +# V1 Universes +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/universes-api/v1.json +``` + +### Vendor Extensions + +Roblox uses [specification extensions](https://spec.openapis.org/oas/v3.0.4#specification-extensions) to extend the OpenAPI specification. These extensions represent information that the specification doesn't capture by default. Extensions may appear throughout the file where allowed by the OpenAPI specification. + +The majority of these specification extensions are experimental. The extensions used are subject to change without notice in favor of fields found within the official OpenAPI specification. + + +The OpenAPI descriptions for V1 and V2 resources utilitize distinct specification extensions due to underlying implementation differences. + + +**V1 Resource Specification Extensions** + +| Extension | Location | Description | +|------------------------------------------------- |------------------ |------------------------------------------------------------------------------------------------- | +| `x-roblox-cloud-api-operation` | Operation Object | Boolean. Whether the operation is an Open Cloud operation. | +| `x-roblox-cloud-api-operation-name` | Operation Object | String. The name of the operation. | +| `x-roblox-cloud-api-operation-code-samples` | Operation Object | Object. A list of code samples, an object with the language/title and the corresponding script. | +| `x-roblox-cloud-api-operation-throttling-limit` | Operation Object | Object. The throttling limits for the operation. | + +**V2 Resource Specification Extensions** + +| Extension | Location | Description | +|--------------------------------------- |------------------ |--------------------------------------------------------------------------------------------------------------- | +| `x-categories` | OpenAPI Object | List of strings. All resource categories. | +| `x-visibility` | Operation Object | Boolean. The visibility of the operation. | +| `x-roblox-docs` | Operation Object | Object. Associates an operation with a category and resource. | +| `x-long-running-operation-parameters` | Operation Object | Object. References the metadata and response for the operation's long running response. | +| `x-oneOf` | Schema Object | Object. Each field contains a list of properties in the schema. Only one of the properties should be present. | +| `x-resource` | Schema Object | Boolean. Whether the schema is a resource. | +| `x-immutable` | Schema Object | Boolean. Whether the schema is immutable. | diff --git a/content/en-us/production/promotion/referral-system.md b/content/en-us/production/promotion/referral-system.md index da243ebeb..5f947599d 100644 --- a/content/en-us/production/promotion/referral-system.md +++ b/content/en-us/production/promotion/referral-system.md @@ -57,7 +57,7 @@ function onPlayerAdded(player) local referredByPlayerId = joinData.ReferredByPlayerId -- Check if the player was invited through a referral - if referredByPlayerId then + if referredByPlayerId and referredByPlayerId ~= 0 then -- Fire the referral event to the client, passing the inviter's ID referrerEvent:FireClient(player, referredByPlayerId) @@ -88,7 +88,7 @@ function onPlayerAdded(player) local referredByPlayerId = joinData.ReferredByPlayerId -- Check if the player was invited through a referral - if referredByPlayerId then + if referredByPlayerId and referredByPlayerId ~= 0 then -- Fire the referral event to the client, passing the inviter's ID referrerEvent:FireClient(player, referredByPlayerId) @@ -130,7 +130,7 @@ function onPlayerAdded(player) local referredByPlayerId = joinData.ReferredByPlayerId -- Check if the player was invited and has not already used a referral - if referredByPlayerId and not referredPlayers[player.UserId] then + if referredByPlayerId and referredByPlayerId ~= 0 and not referredPlayers[player.UserId] then -- Mark the player as referred referredPlayers[player.UserId] = true diff --git a/content/en-us/reference/cloud/README.md b/content/en-us/reference/cloud/README.md index 894a367b4..6bafca878 100644 --- a/content/en-us/reference/cloud/README.md +++ b/content/en-us/reference/cloud/README.md @@ -1,6 +1,6 @@ # Open Cloud Reference -The Open Cloud V2 reference documentation at [https://create.roblox.com/docs/cloud/reference](https://create.roblox.com/docs/cloud/reference) is rendered from `cloud.docs.json`. This file uses a custom JSON format that is similar, but not identical to the OpenAPI Specification (OAS). +The Open Cloud V2 reference documentation at [https://create.roblox.com/docs/cloud/reference](https://create.roblox.com/docs/cloud/reference) is rendered from `cloud.docs.json`. This file uses OpenAPI specification (OAS) version 3.0.4. - Because the content in `cloud.docs.json` is generated from source files, we don't accept pull requests on it. - We **do** accept pull requsts on the V1 reference documentation, but formatting the content and modifying the `curl` commands can be a real challenge. diff --git a/content/en-us/reference/cloud/assets/v1.json b/content/en-us/reference/cloud/assets/v1.json index f5b6584c5..e122d587f 100644 --- a/content/en-us/reference/cloud/assets/v1.json +++ b/content/en-us/reference/cloud/assets/v1.json @@ -12,75 +12,77 @@ ], "paths": { "/v1/assets": { - "get": { + "post": { "tags": ["Assets"], "x-roblox-cloud-api-operation": true, - "x-roblox-cloud-api-operation-name": "Get Asset", - "summary": "Retrieve specific asset content. Include the `readMask` parameter for additional asset metadata.", - "description": "Retrieve specific asset content and metadata.", + "x-roblox-cloud-api-operation-name": "Create Asset", + "summary": "Creates an asset with provided content and metadata.", + "description": "Creates an asset with provided content and metadata.\n\nYou can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).\n\nProvide the asset attributes, binary asset file path, and content type in the form data. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits).", "operationId": "Assets_CreateAsset", - "parameters": [ - { - "name": "assetId", - "in": "path", - "description": "The unique identifier of the asset.", - "required": true, - "schema": { - "$ref": "#/components/schemas/Asset" - } - }, - { - "name": "readMask", - "in": "query", - "description": "Asset metadata fields to retrieve, including the description, display name, icon, social links, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.", - "schema": { - "type": "string" + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "request": { + "$ref": "#/components/schemas/Asset", + "description": "Asset attributes to create." + }, + "fileContent": { + "type": "string", + "format": "binary", + "description": "The binary asset file path and the content type. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits)." + } + }, + "required": [ + "request", + "fileContent" + ] + } } } - ], + }, "responses": { "200": { - "description": "Asset resource retrieved successfully.", + "description": "Returns the Operation ID for checking the creation status.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Asset" + "$ref": "#/components/schemas/Operation" } } } }, "400": { - "description": "Malformed request, likely due to an invalid read mask." + "description": "Invalid argument. Failed to parse the request or the file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Status" + } + } + } }, "401": { "description": "The API key is not valid for this operation / You don't have the authorization." }, - "403": { - "description": "Doesn't have the required permission." - }, - "404": { - "description": "Asset doesn't exist." - }, "500": { "description": "Server internal error / Unknown error." } }, "security": [ { - "roblox-api-key": ["Label.Read"] + "roblox-api-key": ["Label.Read", "Label.Write"] }, { - "roblox-oauth2": ["asset:read"] + "roblox-oauth2": ["asset:read", "asset:write"] } ], "x-roblox-cloud-api-operation-code-samples": [ { - "language": "Get Asset without readMask", - "script": "curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \\\n--header 'x-api-key: {apiKey}'" - }, - { - "language": "Get Asset with readMask", - "script": "curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \\\n--header 'x-api-key: {apiKey}'" + "language": "Create Asset", + "script": "curl --location --request POST 'https://apis.roblox.com/assets/v1/assets' \\\n--header 'x-api-key: {apiKey}' \\\n--form 'request=\"{ \n \\\"assetType\\\": \\\"Model\\\", \n \\\"displayName\\\": \\\"Name\\\", \n \\\"description\\\": \\\"This is a description\\\", \n \\\"creationContext\\\": { \n \\\"creator\\\": { \n \\\"userId\\\": \\\"${userId}\\\" \n } \n } \n}\"' \\\n--form 'fileContent=@\"/filepath/model.fbx\";type=model/fbx' \n" } ], "x-roblox-throttling-limit": { @@ -89,29 +91,30 @@ "maxInPeriod": 60 } } - }, - "post": { + } + }, + "/v1/assets/{assetId}": { + "get": { "tags": ["Assets"], "x-roblox-cloud-api-operation": true, - "x-roblox-cloud-api-operation-name": "Create Asset", - "summary": "Creates an asset with provided content and metadata.", - "description": "Creates an asset with provided content and metadata.\n\nYou can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).", - "operationId": "Assets_CreateAsset", + "x-roblox-cloud-api-operation-name": "Get Asset", + "summary": "Retrieve specific asset content. Include the `readMask` parameter for additional asset metadata.", + "description": "Retrieve specific asset content and metadata.", + "operationId": "Assets_GetAsset", "parameters": [ { - "name": "request", - "in": "formData", - "description": "Asset attributes to create or update. Send as form data like the following example request shows.", + "name": "assetId", + "in": "path", + "description": "The unique identifier of the asset.", "required": true, "schema": { - "$ref": "#/components/schemas/Asset" + "type": "string" } }, { - "name": "fileContent", - "in": "formData", - "description": "The binary asset file path and the content type. Format: `fileContent=@\"/filepath/{File}\";type={ContentType}`. Example: `fileContent=@\"/filepath/model.fbx\";type=model/fbx`. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits).", - "required": true, + "name": "readMask", + "in": "query", + "description": "Asset metadata fields to retrieve, including the description, display name, icon, social links, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.", "schema": { "type": "string" } @@ -119,44 +122,47 @@ ], "responses": { "200": { - "description": "Returns the Operation ID for checking the creation status.", + "description": "Asset resource retrieved successfully.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Operation" + "$ref": "#/components/schemas/Asset" } } } }, "400": { - "description": "Invalid argument. Failed to parse the request or the file.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Status" - } - } - } + "description": "Malformed request, likely due to an invalid read mask." }, "401": { "description": "The API key is not valid for this operation / You don't have the authorization." }, + "403": { + "description": "Doesn't have the required permission." + }, + "404": { + "description": "Asset doesn't exist." + }, "500": { "description": "Server internal error / Unknown error." } }, "security": [ { - "roblox-api-key": ["Label.Read", "Label.Write"] + "roblox-api-key": ["Label.Read"] }, { - "roblox-oauth2": ["asset:read", "asset:write"] + "roblox-oauth2": ["asset:read"] } ], "x-roblox-cloud-api-operation-code-samples": [ { - "language": "Create Asset", - "script": "curl --location --request POST 'https://apis.roblox.com/assets/v1/assets' \\\n--header 'x-api-key: {apiKey}' \\\n--form 'request=\"{ \n \\\"assetType\\\": \\\"Model\\\", \n \\\"displayName\\\": \\\"Name\\\", \n \\\"description\\\": \\\"This is a description\\\", \n \\\"creationContext\\\": { \n \\\"creator\\\": { \n \\\"userId\\\": \\\"${userId}\\\" \n } \n } \n}\"' \\\n--form 'fileContent=@\"/filepath/model.fbx\";type=model/fbx' \n" + "language": "Get Asset without readMask", + "script": "curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}' \\\n--header 'x-api-key: {apiKey}'" + }, + { + "language": "Get Asset with readMask", + "script": "curl --location --request GET 'https://apis.roblox.com/assets/v1/assets/{assetId}?readMask={read_mask}' \\\n--header 'x-api-key: {apiKey}'" } ], "x-roblox-throttling-limit": { @@ -165,30 +171,20 @@ "maxInPeriod": 60 } } - } - }, - "/v1/assets/{assetId}": { + }, "patch": { "tags": ["Assets"], "x-roblox-cloud-api-operation": true, "x-roblox-cloud-api-operation-name": "Update Asset", "summary": "Updates an asset with provided content and metadata.", - "description": "Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.", + "description": "Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.\n\nProvide the asset attributes, binary asset file path, and content type in the form data. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits).", "operationId": "Assets_UpdateAsset", "parameters": [ { - "name": "request", - "in": "formData", - "description": "Send as form data like the following example requests.", + "name": "assetId", + "in": "path", + "description": "The unique identifier of the asset.", "required": true, - "schema": { - "$ref": "#/components/schemas/Asset" - } - }, - { - "name": "fileContent", - "in": "formData", - "description": "The binary asset file path and the content type. Format: `fileContent=@\"/filepath/{File}\";type={ContentType}`. Example: `fileContent=@\"/filepath/model.fbx\";type=model/fbx`. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits).", "schema": { "type": "string" } @@ -205,13 +201,27 @@ ], "requestBody": { "content": { - "application/json": { + "multipart/form-data": { "schema": { - "$ref": "#/components/schemas/Asset" + "type": "object", + "properties": { + "request": { + "$ref": "#/components/schemas/Asset", + "description": "Asset attributes to update." + }, + "fileContent": { + "type": "string", + "format": "binary", + "description": "The binary asset file path and the content type. See [Content Types](../../../cloud/open-cloud/usage-assets.md#supported-asset-types-and-limits)." + } + }, + "required": [ + "request", + "fileContent" + ] } } - }, - "required": true + } }, "responses": { "200": { @@ -527,7 +537,7 @@ "x-roblox-cloud-api-operation": true, "x-roblox-cloud-api-operation-name": "Rollback Asset Version", "summary": "Rollback an asset to a previous version.", - "description": "Rollback an asset to a specific previous version.", + "description": "Rollback an asset to a specific previous version.\n\n Provide the asset version path in the form data.", "operationId": "Assets_RollbackAssetVersion", "parameters": [ { @@ -536,24 +546,22 @@ "description": "The unique identifier of the asset.", "required": true, "schema": { "type": "string" } - }, - { - "name": "assetVersion", - "in": "formData", - "description": "The asset version path in the format of `assets/{assetId}/versions/{versionNumber}`.", - "required": true, - "schema": { "type": "string" } } ], "requestBody": { - "required": true, "content": { - "application/json": { + "multipart/form-data": { "schema": { "type": "object", "properties": { - "assetVersion": { "type": "string" } - } + "assetVersion": { + "type": "string", + "description": "The asset version path in the format of `assets/{assetId}/versions/{versionNumber}`." + } + }, + "required": [ + "assetVersion" + ] } } } @@ -605,8 +613,18 @@ "summary": "Get the result of an asset creation or update.", "description": "Get the result of an asset creation or update using the returned Operation ID. Requires **Read** for the API key permission and **asset:read** for OAuth 2.0 apps.", "operationId": "Assets_GetOperation", + "parameters": [ + { + "name": "operationId", + "in": "path", + "description": "The unique identifier of the operation.", + "required": true, + "schema": { "type": "string" } + } + ], "responses": { "200": { + "description": "Operation result retrieved successfully.", "content": { "application/json": { "schema": { @@ -876,6 +894,20 @@ "type": "apiKey", "name": "roblox-api-key", "in": "header" + }, + "roblox-oauth2": { + "type": "oauth2", + "flows": { + "authorizationCode": { + "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize", + "tokenUrl": "https://apis.roblox.com/oauth/v1/token", + "refreshUrl": "https://apis.roblox.com/oauth/v1/token", + "scopes": { + "asset:read": "This allows viewing information about your assets.", + "asset:write": "This allows uploading and updating assets to Roblox." + } + } + } } } }, diff --git a/content/en-us/reference/cloud/cloud.docs.json b/content/en-us/reference/cloud/cloud.docs.json index f12fd37d1..27cb8dc7d 100644 --- a/content/en-us/reference/cloud/cloud.docs.json +++ b/content/en-us/reference/cloud/cloud.docs.json @@ -66,7 +66,7 @@ "operationId": "Cloud_GetCreatorStoreProduct", "parameters": [ { - "name": "creator-store-product", + "name": "creator_store_product_id", "in": "path", "description": "The creator-store-product ID.", "required": true, @@ -110,7 +110,7 @@ "operationId": "Cloud_UpdateCreatorStoreProduct", "parameters": [ { - "name": "creator-store-product", + "name": "creator_store_product_id", "in": "path", "description": "The creator-store-product ID.", "required": true, @@ -184,7 +184,7 @@ "operationId": "Cloud_GetGroup", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -228,7 +228,7 @@ "operationId": "Cloud_ListGroupJoinRequests", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -305,7 +305,7 @@ "operationId": "Cloud_AcceptGroupJoinRequest", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -314,7 +314,7 @@ } }, { - "name": "join-request", + "name": "join_request_id", "in": "path", "description": "The join-request ID.", "required": true, @@ -364,7 +364,7 @@ "operationId": "Cloud_DeclineGroupJoinRequest", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -373,7 +373,7 @@ } }, { - "name": "join-request", + "name": "join_request_id", "in": "path", "description": "The join-request ID.", "required": true, @@ -423,7 +423,7 @@ "operationId": "Cloud_ListGroupMemberships", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -498,7 +498,7 @@ "operationId": "Cloud_UpdateGroupMembership", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -507,7 +507,7 @@ } }, { - "name": "membership", + "name": "membership_id", "in": "path", "description": "The membership ID.", "required": true, @@ -563,7 +563,7 @@ "operationId": "Cloud_ListGroupRoles", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -630,7 +630,7 @@ "operationId": "Cloud_GetGroupRole", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -639,7 +639,7 @@ } }, { - "name": "role", + "name": "role_id", "in": "path", "description": "The role ID.", "required": true, @@ -683,7 +683,7 @@ "operationId": "Cloud_GetGroupShout", "parameters": [ { - "name": "group", + "name": "group_id", "in": "path", "description": "The group ID.", "required": true, @@ -727,7 +727,7 @@ "operationId": "Cloud_GetUniverse", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -769,7 +769,7 @@ "operationId": "Cloud_UpdateUniverse", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -834,7 +834,7 @@ "operationId": "Cloud_ListDataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -911,7 +911,7 @@ "operationId": "Cloud_ListDataStoreEntries__Using_Universes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -920,7 +920,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1004,7 +1004,7 @@ "operationId": "Cloud_CreateDataStoreEntry__Using_Universes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1013,7 +1013,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1083,7 +1083,7 @@ "operationId": "Cloud_GetDataStoreEntry__Using_Universes_DataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1092,7 +1092,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1101,7 +1101,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1145,7 +1145,7 @@ "operationId": "Cloud_DeleteDataStoreEntry__Using_Universes_DataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1154,7 +1154,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1163,7 +1163,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1201,7 +1201,7 @@ "operationId": "Cloud_UpdateDataStoreEntry__Using_Universes_DataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1210,7 +1210,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1219,7 +1219,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1284,7 +1284,7 @@ "operationId": "Cloud_IncrementDataStoreEntry__Using_Universes_DataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1293,7 +1293,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1302,7 +1302,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1359,7 +1359,7 @@ "operationId": "Cloud_ListDataStoreEntryRevisions__Using_Universes_DataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1368,7 +1368,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1377,7 +1377,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1454,7 +1454,7 @@ "operationId": "Cloud_ListDataStoreEntries__Using_Universes_DataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1463,7 +1463,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1472,7 +1472,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -1556,7 +1556,7 @@ "operationId": "Cloud_CreateDataStoreEntry__Using_Universes_DataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1565,7 +1565,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1574,7 +1574,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -1644,7 +1644,7 @@ "operationId": "Cloud_GetDataStoreEntry__Using_Universes_DataStores_Scopes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1653,7 +1653,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1662,7 +1662,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -1671,7 +1671,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1715,7 +1715,7 @@ "operationId": "Cloud_DeleteDataStoreEntry__Using_Universes_DataStores_Scopes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1724,7 +1724,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1733,7 +1733,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -1742,7 +1742,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1780,7 +1780,7 @@ "operationId": "Cloud_UpdateDataStoreEntry__Using_Universes_DataStores_Scopes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1789,7 +1789,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1798,7 +1798,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -1807,7 +1807,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1872,7 +1872,7 @@ "operationId": "Cloud_IncrementDataStoreEntry__Using_Universes_DataStores_Scopes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1881,7 +1881,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1890,7 +1890,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -1899,7 +1899,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -1956,7 +1956,7 @@ "operationId": "Cloud_ListDataStoreEntryRevisions__Using_Universes_DataStores_Scopes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -1965,7 +1965,7 @@ } }, { - "name": "data-store", + "name": "data_store_id", "in": "path", "description": "The data-store ID.", "required": true, @@ -1974,7 +1974,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -1983,7 +1983,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -2060,7 +2060,7 @@ "operationId": "Cloud_SnapshotDataStores", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2116,7 +2116,7 @@ "operationId": "Cloud_CreateMemoryStoreQueueItem", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2125,7 +2125,7 @@ } }, { - "name": "queue", + "name": "queue_id", "in": "path", "description": "The queue ID.", "required": true, @@ -2181,7 +2181,7 @@ "operationId": "Cloud_DiscardMemoryStoreQueueItems", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2190,7 +2190,7 @@ } }, { - "name": "queue", + "name": "queue_id", "in": "path", "description": "The queue ID.", "required": true, @@ -2240,7 +2240,7 @@ "operationId": "Cloud_ReadMemoryStoreQueueItems", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2249,7 +2249,7 @@ } }, { - "name": "queue", + "name": "queue_id", "in": "path", "description": "The queue ID.", "required": true, @@ -2323,7 +2323,7 @@ "operationId": "Cloud_ListMemoryStoreSortedMapItems", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2332,7 +2332,7 @@ } }, { - "name": "sorted-map", + "name": "sorted_map_id", "in": "path", "description": "The sorted-map ID.", "required": true, @@ -2415,7 +2415,7 @@ "operationId": "Cloud_CreateMemoryStoreSortedMapItem", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2424,7 +2424,7 @@ } }, { - "name": "sorted-map", + "name": "sorted_map_id", "in": "path", "description": "The sorted-map ID.", "required": true, @@ -2494,7 +2494,7 @@ "operationId": "Cloud_GetMemoryStoreSortedMapItem", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2503,7 +2503,7 @@ } }, { - "name": "sorted-map", + "name": "sorted_map_id", "in": "path", "description": "The sorted-map ID.", "required": true, @@ -2512,7 +2512,7 @@ } }, { - "name": "item", + "name": "item_id", "in": "path", "description": "The item ID.", "required": true, @@ -2556,7 +2556,7 @@ "operationId": "Cloud_DeleteMemoryStoreSortedMapItem", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2565,7 +2565,7 @@ } }, { - "name": "sorted-map", + "name": "sorted_map_id", "in": "path", "description": "The sorted-map ID.", "required": true, @@ -2574,7 +2574,7 @@ } }, { - "name": "item", + "name": "item_id", "in": "path", "description": "The item ID.", "required": true, @@ -2612,7 +2612,7 @@ "operationId": "Cloud_UpdateMemoryStoreSortedMapItem", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2621,7 +2621,7 @@ } }, { - "name": "sorted-map", + "name": "sorted_map_id", "in": "path", "description": "The sorted-map ID.", "required": true, @@ -2630,7 +2630,7 @@ } }, { - "name": "item", + "name": "item_id", "in": "path", "description": "The item ID.", "required": true, @@ -2695,7 +2695,7 @@ "operationId": "Cloud_FlushMemoryStore", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2759,7 +2759,7 @@ "operationId": "Cloud_ListOrderedDataStoreEntries", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2768,7 +2768,7 @@ } }, { - "name": "ordered-data-store", + "name": "ordered_data_store_id", "in": "path", "description": "The ordered-data-store ID.", "required": true, @@ -2777,7 +2777,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -2860,7 +2860,7 @@ "operationId": "Cloud_CreateOrderedDataStoreEntry", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2869,7 +2869,7 @@ } }, { - "name": "ordered-data-store", + "name": "ordered_data_store_id", "in": "path", "description": "The ordered-data-store ID.", "required": true, @@ -2878,7 +2878,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -2948,7 +2948,7 @@ "operationId": "Cloud_GetOrderedDataStoreEntry", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -2957,7 +2957,7 @@ } }, { - "name": "ordered-data-store", + "name": "ordered_data_store_id", "in": "path", "description": "The ordered-data-store ID.", "required": true, @@ -2966,7 +2966,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -2975,7 +2975,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -3019,7 +3019,7 @@ "operationId": "Cloud_DeleteOrderedDataStoreEntry", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3028,7 +3028,7 @@ } }, { - "name": "ordered-data-store", + "name": "ordered_data_store_id", "in": "path", "description": "The ordered-data-store ID.", "required": true, @@ -3037,7 +3037,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -3046,7 +3046,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -3084,7 +3084,7 @@ "operationId": "Cloud_UpdateOrderedDataStoreEntry", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3093,7 +3093,7 @@ } }, { - "name": "ordered-data-store", + "name": "ordered_data_store_id", "in": "path", "description": "The ordered-data-store ID.", "required": true, @@ -3102,7 +3102,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -3111,7 +3111,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -3176,7 +3176,7 @@ "operationId": "Cloud_IncrementOrderedDataStoreEntry", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3185,7 +3185,7 @@ } }, { - "name": "ordered-data-store", + "name": "ordered_data_store_id", "in": "path", "description": "The ordered-data-store ID.", "required": true, @@ -3194,7 +3194,7 @@ } }, { - "name": "scope", + "name": "scope_id", "in": "path", "description": "The scope ID.", "required": true, @@ -3203,7 +3203,7 @@ } }, { - "name": "entry", + "name": "entry_id", "in": "path", "description": "The entry ID.", "required": true, @@ -3259,7 +3259,7 @@ "operationId": "Cloud_GetPlace", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3268,7 +3268,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3310,7 +3310,7 @@ "operationId": "Cloud_UpdatePlace", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3319,7 +3319,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3384,7 +3384,7 @@ "operationId": "Cloud_GetInstance", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3393,7 +3393,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3402,7 +3402,7 @@ } }, { - "name": "instance", + "name": "instance_id", "in": "path", "description": "The instance ID.", "required": true, @@ -3454,7 +3454,7 @@ "operationId": "Cloud_UpdateInstance", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3463,7 +3463,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3472,7 +3472,7 @@ } }, { - "name": "instance", + "name": "instance_id", "in": "path", "description": "The instance ID.", "required": true, @@ -3545,7 +3545,7 @@ "operationId": "Cloud_ListInstanceChildren", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3554,7 +3554,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3563,7 +3563,7 @@ } }, { - "name": "instance", + "name": "instance_id", "in": "path", "description": "The instance ID.", "required": true, @@ -3640,7 +3640,7 @@ "operationId": "Cloud_CreateLuauExecutionSessionTask__Using_Universes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3649,7 +3649,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3705,7 +3705,7 @@ "operationId": "Cloud_ListLuauExecutionSessionTaskLogs__Using_Universes_Places", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3714,7 +3714,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3723,7 +3723,7 @@ } }, { - "name": "luau-execution-session-task", + "name": "luau_execution_session_task_id", "in": "path", "description": "The luau-execution-session-task ID.", "required": true, @@ -3793,7 +3793,7 @@ "operationId": "Cloud_GetLuauExecutionSessionTask__Using_Universes_Places_LuauExecutionSessions", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3802,7 +3802,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3811,7 +3811,7 @@ } }, { - "name": "luau-execution-session", + "name": "luau_execution_session_id", "in": "path", "description": "The luau-execution-session ID.", "required": true, @@ -3820,7 +3820,7 @@ } }, { - "name": "task", + "name": "task_id", "in": "path", "description": "The task ID.", "required": true, @@ -3882,7 +3882,7 @@ "operationId": "Cloud_ListLuauExecutionSessionTaskLogs__Using_Universes_Places_LuauExecutionSessions", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3891,7 +3891,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -3900,7 +3900,7 @@ } }, { - "name": "luau-execution-session", + "name": "luau_execution_session_id", "in": "path", "description": "The luau-execution-session ID.", "required": true, @@ -3909,7 +3909,7 @@ } }, { - "name": "task", + "name": "task_id", "in": "path", "description": "The task ID.", "required": true, @@ -3979,7 +3979,7 @@ "operationId": "Cloud_ListUserRestrictions__Using_Universes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -3988,7 +3988,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -4065,7 +4065,7 @@ "operationId": "Cloud_GetUserRestriction__Using_Universes_Places", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4074,7 +4074,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -4083,7 +4083,7 @@ } }, { - "name": "user-restriction", + "name": "user_restriction_id", "in": "path", "description": "The user-restriction ID.", "required": true, @@ -4127,7 +4127,7 @@ "operationId": "Cloud_UpdateUserRestriction__Using_Universes_Places", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4136,7 +4136,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -4145,7 +4145,7 @@ } }, { - "name": "user-restriction", + "name": "user_restriction_id", "in": "path", "description": "The user-restriction ID.", "required": true, @@ -4228,7 +4228,7 @@ "operationId": "Cloud_CreateLuauExecutionSessionTask__Using_Universes_Places", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4237,7 +4237,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -4246,7 +4246,7 @@ } }, { - "name": "version", + "name": "version_id", "in": "path", "description": "The version ID.", "required": true, @@ -4302,7 +4302,7 @@ "operationId": "Cloud_ListLuauExecutionSessionTaskLogs__Using_Universes_Places_Versions", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4311,7 +4311,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -4320,7 +4320,7 @@ } }, { - "name": "version", + "name": "version_id", "in": "path", "description": "The version ID.", "required": true, @@ -4329,7 +4329,7 @@ } }, { - "name": "luau-execution-session-task", + "name": "luau_execution_session_task_id", "in": "path", "description": "The luau-execution-session-task ID.", "required": true, @@ -4399,7 +4399,7 @@ "operationId": "Cloud_GetLuauExecutionSessionTask__Using_Universes_Places_Versions_LuauExecutionSessions", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4408,7 +4408,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -4417,7 +4417,7 @@ } }, { - "name": "version", + "name": "version_id", "in": "path", "description": "The version ID.", "required": true, @@ -4426,7 +4426,7 @@ } }, { - "name": "luau-execution-session", + "name": "luau_execution_session_id", "in": "path", "description": "The luau-execution-session ID.", "required": true, @@ -4435,7 +4435,7 @@ } }, { - "name": "task", + "name": "task_id", "in": "path", "description": "The task ID.", "required": true, @@ -4497,7 +4497,7 @@ "operationId": "Cloud_ListLuauExecutionSessionTaskLogs__Using_Universes_Places_Versions_LuauExecutionSessions", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4506,7 +4506,7 @@ } }, { - "name": "place", + "name": "place_id", "in": "path", "description": "The place ID.", "required": true, @@ -4515,7 +4515,7 @@ } }, { - "name": "version", + "name": "version_id", "in": "path", "description": "The version ID.", "required": true, @@ -4524,7 +4524,7 @@ } }, { - "name": "luau-execution-session", + "name": "luau_execution_session_id", "in": "path", "description": "The luau-execution-session ID.", "required": true, @@ -4533,7 +4533,7 @@ } }, { - "name": "task", + "name": "task_id", "in": "path", "description": "The task ID.", "required": true, @@ -4603,7 +4603,7 @@ "operationId": "Cloud_GetSubscription", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4612,7 +4612,7 @@ } }, { - "name": "subscription-product", + "name": "subscription_product_id", "in": "path", "description": "The subscription-product ID.", "required": true, @@ -4621,7 +4621,7 @@ } }, { - "name": "subscription", + "name": "subscription_id", "in": "path", "description": "The subscription ID.", "required": true, @@ -4683,7 +4683,7 @@ "operationId": "Cloud_ListUserRestrictions", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4760,7 +4760,7 @@ "operationId": "Cloud_GetUserRestriction__Using_Universes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4769,7 +4769,7 @@ } }, { - "name": "user-restriction", + "name": "user_restriction_id", "in": "path", "description": "The user-restriction ID.", "required": true, @@ -4813,7 +4813,7 @@ "operationId": "Cloud_UpdateUserRestriction__Using_Universes", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4822,7 +4822,7 @@ } }, { - "name": "user-restriction", + "name": "user_restriction_id", "in": "path", "description": "The user-restriction ID.", "required": true, @@ -4905,7 +4905,7 @@ "operationId": "Cloud_ListUserRestrictionLogs", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -4982,7 +4982,7 @@ "operationId": "Cloud_PublishUniverseMessage", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -5032,7 +5032,7 @@ "operationId": "Cloud_RestartUniverseServers", "parameters": [ { - "name": "universe", + "name": "universe_id", "in": "path", "description": "The universe ID.", "required": true, @@ -5088,7 +5088,7 @@ "operationId": "Cloud_GetUser", "parameters": [ { - "name": "user", + "name": "user_id", "in": "path", "description": "The user ID.", "required": true, @@ -5132,7 +5132,7 @@ "operationId": "Cloud_ListInventoryItems", "parameters": [ { - "name": "user", + "name": "user_id", "in": "path", "description": "The user ID.", "required": true, @@ -5207,7 +5207,7 @@ "operationId": "Cloud_CreateUserNotification", "parameters": [ { - "name": "user", + "name": "user_id", "in": "path", "description": "The user ID.", "required": true, @@ -5263,7 +5263,7 @@ "operationId": "Cloud_GenerateUserThumbnail", "parameters": [ { - "name": "user", + "name": "user_id", "in": "path", "description": "The user ID.", "required": true, diff --git a/content/en-us/reference/cloud/datastores-api/ordered-v1.json b/content/en-us/reference/cloud/datastores-api/ordered-v1.json index cd21485b5..b6566838b 100644 --- a/content/en-us/reference/cloud/datastores-api/ordered-v1.json +++ b/content/en-us/reference/cloud/datastores-api/ordered-v1.json @@ -100,6 +100,11 @@ "description": "Too Many Requests." } }, + "security": [ + { + "roblox-api-key": ["Label.Read"] + } + ], "x-roblox-cloud-api-operation-code-samples": [ { "language": "curl", @@ -148,14 +153,6 @@ "schema": { "type": "string" } - }, - { - "name": "CreateEntryRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/CreateEntryRequest" - } } ], "requestBody": { @@ -192,6 +189,11 @@ "description": "Too Many Requests." } }, + "security": [ + { + "roblox-api-key": ["Label.Write"] + } + ], "x-roblox-cloud-api-operation-code-samples": [ { "language": "curl", @@ -268,6 +270,11 @@ "description": "Too Many Requests." } }, + "security": [ + { + "roblox-api-key": ["Label.Read"] + } + ], "x-roblox-cloud-api-operation-code-samples": [ { "language": "curl", @@ -335,6 +342,11 @@ "description": "Too Many Requests." } }, + "security": [ + { + "roblox-api-key": ["Label.Write"] + } + ], "x-roblox-cloud-api-operation-code-samples": [ { "language": "curl", @@ -349,7 +361,7 @@ "x-roblox-cloud-api-operation-name": "Update", "parameters": [ { - "name": "universeIdId", + "name": "universeId", "in": "path", "description": "The identifier of the experience with ordered data stores that you want to access. See [Universe ID](../../../cloud/open-cloud/data-store-api-handling.md#universe-id) on how to copy it on [Creator Dashboard](https://create.roblox.com/dashboard/creations).", "required": true, @@ -384,14 +396,6 @@ "type": "string" } }, - { - "name": "UpdateEntryRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/UpdateEntryRequest" - } - }, { "name": "allow_missing", "in": "query", @@ -438,6 +442,11 @@ "description": "Too Many Requests." } }, + "security": [ + { + "roblox-api-key": ["Label.Write"] + } + ], "x-roblox-cloud-api-operation-code-samples": [ { "language": "curl", @@ -488,14 +497,6 @@ "schema": { "type": "string" } - }, - { - "name": "incrementEntryRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/components/schemas/IncrementEntryRequest" - } } ], "requestBody": { @@ -532,6 +533,11 @@ "description": "Too Many Requests." } }, + "security": [ + { + "roblox-api-key": ["Label.Write"] + } + ], "x-roblox-cloud-api-operation-code-samples": [ { "language": "curl", @@ -615,6 +621,13 @@ }, "description": "A list of Entries in the parent collection." } + }, + "securitySchemes": { + "roblox-api-key": { + "type": "apiKey", + "name": "roblox-api-key", + "in": "header" + } } }, "tags": [ diff --git a/content/en-us/reference/cloud/datastores-api/v1.json b/content/en-us/reference/cloud/datastores-api/v1.json index 18693d082..f8ea9bce9 100644 --- a/content/en-us/reference/cloud/datastores-api/v1.json +++ b/content/en-us/reference/cloud/datastores-api/v1.json @@ -61,23 +61,6 @@ "responses": { "200": { "description": "", - "headers": { - "date": { - "schema": { - "type": "date-time" - } - }, - "content-type": { - "schema": { - "type": "string" - } - }, - "conent-length": { - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { @@ -199,23 +182,6 @@ "responses": { "200": { "description": "", - "headers": { - "date": { - "schema": { - "type": "date-time" - } - }, - "content-type": { - "schema": { - "type": "string" - } - }, - "conent-length": { - "schema": { - "type": "integer" - } - } - }, "content": { "application/json": { "schema": { @@ -264,7 +230,7 @@ "get": { "tags": ["Entries"], "summary": "Get entry.", - "description": "Returns the value and metadata associated with an entry.", + "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/open-cloud/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", "operationId": "Entries_GetEntryAsync", "x-roblox-cloud-api-operation-name": "Get Entry", "parameters": [ @@ -309,93 +275,57 @@ ], "responses": { "200": { - "description": "Returns the user content of the entry in the body of the response.", + "description": "Successfully retrieved the entry.", "headers": { - "date": { - "schema": { - "type": "date-time" - } - }, - "content-type": { - "schema": { - "type": "string" - } - }, - "conent-length": { - "schema": { - "type": "integer" - } - }, "content-md5": { "schema": { - "type": "string" - } + "type": "string", + "format": "byte" + }, + "description": "The base-64 encoded MD5 checksum of the content. See [Content-MD5](../../../cloud/open-cloud/data-store-api-handling.md#content-md5)." }, "roblox-entry-version": { "schema": { - "type": "string" - } + "type": "string", + "format": "binary" + }, + "description": "The version of the returned entry." }, "roblox-entry-created-time": { "schema": { - "type": "date-time" - } + "type": "string", + "format": "date-time" + }, + "description": "The time at which the entry was created." }, "roblox-entry-version-created-time": { "schema": { - "type": "date-time" - } + "type": "string", + "format": "date-time" + }, + "description": "The time at which this particular version was created." + }, + "roblox-entry-attributes": { + "schema": { + "type": "object" + }, + "description": "Attributes tagged with the entry. Serialized JSON map object." }, "roblox-entry-userids": { "schema": { - "type": "array" - } + "type": "array", + "items": { + "type": "integer" + } + }, + "description": "Comma-separated list of Roblox user IDs tagged with the entry." } }, "content": { "application/json": { "schema": { "type": "object", - "properties": { - "roblox-entry-created-time": { - "type": "string", - "description": "The time at which the entry was created.", - "format": "date-time" - }, - "last-modified": { - "type": "string", - "description": "The time at which this particular version was created.", - "format": "date-time" - }, - "roblox-entry-version": { - "type": "string", - "description": "The version of the returned entry.", - "format": "binary" - }, - "roblox-entry-attributes": { - "type": "string", - "description": "Attributes associated with the returned entry. Serialized JSON map object.", - "format": "binary" - }, - "roblox-entry-userids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Comma-separated list of Roblox user IDs tagged with the entry." - }, - "content-md5": { - "type": "string", - "description": "The base-64 encoded MD5 checksum of the content. See [Content-MD5](../../../cloud/open-cloud/data-store-api-handling.md#content-md5).", - "format": "binary" - } - }, - "example": "{\n \"content-md5\": \"zuYxEhwuySMvOi8CitXImw==\",\n \"roblox-entry-version\": \"08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01\",\n \"roblox-entry-created-time\": \"2022-02-02T23:30:06.5388799+00:00\",\n \"roblox-entry-version-created-time\": \"2022-02-02T23:30:06.5388799+00:00\",\n \"roblox-entry-userids\": [ 1, 2, 3 ]\n}" - }, - "encoding": { - "metadata": { - "contentType": "application/json; charset=utf-8; content-length=388;" - } + "description": "The user content of the entry." } } } @@ -523,23 +453,6 @@ "responses": { "200": { "description": "", - "headers": { - "date": { - "schema": { - "type": "date-time" - } - }, - "content-type": { - "schema": { - "type": "string" - } - }, - "conent-length": { - "schema": { - "type": "integer" - } - } - }, "content": { "text/json": { "schema": { @@ -614,14 +527,7 @@ ], "responses": { "204": { - "description": "The entry is deleted.", - "headers": { - "date": { - "schema": { - "type": "date-time" - } - } - } + "description": "The entry is deleted." } }, "security": [ @@ -643,7 +549,7 @@ "post": { "tags": ["Entries"], "summary": "Increment entry", - "description": "Increments the value for an entry by a given amount, or create a new entry with that amount.", + "description": "Increments the value for an entry by a given amount, or create a new entry with that amount. Returns the entry and metadata.\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/open-cloud/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", "operationId": "Entries_IncrementEntryAsync", "x-roblox-cloud-api-operation-name": "Increment Entry", "parameters": [ @@ -718,91 +624,55 @@ "200": { "description": "Returns the latest version of the entry after it has been incremented.", "headers": { - "date": { - "schema": { - "type": "date-time" - } - }, - "content-type": { - "schema": { - "type": "string" - } - }, - "conent-length": { - "schema": { - "type": "integer" - } - }, "content-md5": { "schema": { - "type": "string" - } + "type": "string", + "format": "byte" + }, + "description": "The base-64 encoded MD5 checksum of the content. See [Content-MD5](../../../cloud/open-cloud/data-store-api-handling.md#content-md5)." }, "roblox-entry-version": { "schema": { - "type": "string" - } + "type": "string", + "format": "binary" + }, + "description": "The version of the returned entry." }, "roblox-entry-created-time": { "schema": { - "type": "date-time" - } + "type": "string", + "format": "date-time" + }, + "description": "The time at which the entry was created." }, "roblox-entry-version-created-time": { "schema": { - "type": "date-time" - } + "type": "string", + "format": "date-time" + }, + "description": "The time at which this particular version was created." + }, + "roblox-entry-attributes": { + "schema": { + "type": "object" + }, + "description": "Attributes tagged with the entry. Serialized JSON map object." }, "roblox-entry-userids": { "schema": { - "type": "array" - } + "type": "array", + "items": { + "type": "integer" + } + }, + "description": "Comma-separated list of Roblox user IDs tagged with the entry." } }, "content": { "application/json": { "schema": { "type": "object", - "properties": { - "roblox-entry-created-time": { - "type": "string", - "description": "The time at which the entry was created.", - "format": "date-time" - }, - "last-modified": { - "type": "string", - "description": "The time at which this particular version was created.", - "format": "date-time" - }, - "roblox-entry-version": { - "type": "string", - "description": "The version of the returned entry.", - "format": "binary" - }, - "roblox-entry-attributes": { - "type": "string", - "description": "Attributes associated with the returned entry. Serialized JSON map object.", - "format": "binary" - }, - "roblox-entry-userids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Comma-separated list of Roblox user IDs tagged with the entry." - }, - "content-md5": { - "type": "string", - "description": "The base-64 encoded MD5 checksum of the content. See [Content-MD5](../../../cloud/open-cloud/data-store-api-handling.md#content-md5).", - "format": "binary" - } - }, - "example": "{\n \"content-md5\": \"K4phWUsfTE2wkCqKOVztkw==\",\n \"roblox-entry-version\": \"08D9E6A3F2188CFF.0000000009.08D9E6DF74AC5F42.01\",\n \"roblox-entry-created-time\": \"2022-02-02T23:30:06.5388799+00:00\",\n \"roblox-entry-version-created-time\": \"2022-02-03T06:36:05.9184962+00:00\",\n \"roblox-entry-userids\": []\n}" - }, - "encoding": { - "metadata": { - "contentType": "application/json; charset=utf-8; content-length=388;" - } + "description": "The user content of the entry." } } } @@ -833,7 +703,7 @@ "get": { "tags": ["Entries"], "summary": "Get entry version.", - "description": "Returns the value and metadata of a specific version of an entry.", + "description": "Returns the value and metadata of a specific version of 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/open-cloud/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", "operationId": "Entries_GetEntryVersionAsync", "x-roblox-cloud-api-operation-name": "Get Entry Version", "parameters": [ @@ -887,81 +757,57 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the entry.", "headers": { - "date": { - "schema": { - "type": "date-time" - } - }, - "content-type": { - "schema": { - "type": "string" - } - }, - "conent-length": { - "schema": { - "type": "integer" - } - }, "content-md5": { "schema": { - "type": "string" - } + "type": "string", + "format": "byte" + }, + "description": "The base-64 encoded MD5 checksum of the content. See [Content-MD5](../../../cloud/open-cloud/data-store-api-handling.md#content-md5)." }, "roblox-entry-version": { "schema": { - "type": "string" - } + "type": "string", + "format": "binary" + }, + "description": "The version of the returned entry." }, "roblox-entry-created-time": { "schema": { - "type": "date-time" - } + "type": "string", + "format": "date-time" + }, + "description": "The time at which the entry was created." }, "roblox-entry-version-created-time": { "schema": { - "type": "date-time" - } + "type": "string", + "format": "date-time" + }, + "description": "The time at which this particular version was created." }, "roblox-entry-attributes": { "schema": { - "type": "string" - } + "type": "object" + }, + "description": "Attributes tagged with the entry. Serialized JSON map object." }, "roblox-entry-userids": { "schema": { - "type": "array" - } + "type": "array", + "items": { + "type": "integer" + } + }, + "description": "Comma-separated list of Roblox user IDs tagged with the entry." } }, "content": { "application/json": { "schema": { "type": "object", - "properties": { - "roblox-entry-created-time": { - "type": "string", - "description": "The time at which the entry was created.", - "format": "date-time" - }, - "last-modified": { - "type": "string", - "description": "The time at which this particular version was created.", - "format": "date-time" - }, - "roblox-entry-version": { - "type": "string", - "description": "The version of the returned entry.", - "format": "binary" - } - }, - "example": "{\n \"content-md5\": \"sTf90fedVsft8zZf6nUg8g==\",\n \"roblox-entry-version\": \"08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01\",\n \"roblox-entry-created-time\": \"2022-02-02T23:30:06.5388799+00:00\",\n \"roblox-entry-version-created-time\": \"2022-02-03T06:27:42.0652160+00:00\",\n \"roblox-entry-attributes\": {},\n \"roblox-entry-userids\": [ 269323 ]\n}" - }, - "encoding": { - "metadata": { - "contentType": "application/json; charset=utf-8; content-length=388;" - } + "description": "The user content of the entry." } } } @@ -1087,23 +933,6 @@ "responses": { "200": { "description": "", - "headers": { - "date": { - "schema": { - "type": "date-time" - } - }, - "content-type": { - "schema": { - "type": "string" - } - }, - "conent-length": { - "schema": { - "type": "integer" - } - } - }, "content": { "text/json": { "schema": { diff --git a/content/en-us/reference/cloud/messaging-service/v1.json b/content/en-us/reference/cloud/messaging-service/v1.json index d2cd7e23a..91f0b04bf 100644 --- a/content/en-us/reference/cloud/messaging-service/v1.json +++ b/content/en-us/reference/cloud/messaging-service/v1.json @@ -106,6 +106,26 @@ }, "additionalProperties": false } + }, + "securitySchemes": { + "roblox-api-key": { + "type": "apiKey", + "name": "roblox-api-key", + "in": "header" + }, + "roblox-oauth2": { + "type": "oauth2", + "flows": { + "authorizationCode": { + "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize", + "tokenUrl": "https://apis.roblox.com/oauth/v1/token", + "refreshUrl": "https://apis.roblox.com/oauth/v1/token", + "scopes": { + "universe-messaging-service:publish": "This grants the ability to publish messages on behalf of users." + } + } + } + } } } } diff --git a/content/en-us/reference/cloud/universes-api/v1.json b/content/en-us/reference/cloud/universes-api/v1.json index 4921c8346..4e3ff4c07 100644 --- a/content/en-us/reference/cloud/universes-api/v1.json +++ b/content/en-us/reference/cloud/universes-api/v1.json @@ -79,7 +79,11 @@ "description": "Server internal error / Unknown error." } }, - "security": [], + "security": [ + { + "roblox-api-key": ["Label.Write"] + } + ], "x-roblox-cloud-api-operation": true, "x-roblox-code-samples": [ { @@ -96,5 +100,14 @@ "x-roblox-size-limit": 10485760 } } + }, + "components": { + "securitySchemes": { + "roblox-api-key": { + "type": "apiKey", + "name": "roblox-api-key", + "in": "header" + } + } } } diff --git a/content/en-us/reference/engine/classes/Stats.yaml b/content/en-us/reference/engine/classes/Stats.yaml index d947716f1..d7f4946a8 100644 --- a/content/en-us/reference/engine/classes/Stats.yaml +++ b/content/en-us/reference/engine/classes/Stats.yaml @@ -348,13 +348,11 @@ properties: writeCapabilities: [] - name: Stats.RenderCPUFrameTime summary: | - A measurement of how long it takes for the CPU to process all of its tasks - required to render a frame. + A measurement of how long it takes for the CPU to process all of its + rendering tasks for a frame. description: | This property is a measurement of how long it takes for the CPU to process - all of its tasks required to render a frame. A high value can indicate - that the CPU is taking longer to render a frame, which can lead to - performance issues. + all of its rendering tasks for a frame. code_samples: [] type: float tags: @@ -377,9 +375,7 @@ properties: required to render a frame. description: | This property is a measurement of how long it takes for the GPU to process - all of its tasks required to render a frame. A high value can indicate - that the GPU is taking longer to render a frame, which can lead to - performance issues. + all of its tasks required to render a frame. code_samples: [] type: float tags: @@ -471,7 +467,7 @@ properties: writeCapabilities: [] - name: Stats.ShadowsTriangleCount summary: | - A measurement of the number of traingles rendered as shadows in the game's + A measurement of the number of triangles rendered as shadows in the game's current scene. description: | This property is a measurement of the number of triangles rendered as diff --git a/tools/checks/utils/allowedHttpLinks.txt b/tools/checks/utils/allowedHttpLinks.txt index b09df3c92..e32c719f0 100644 --- a/tools/checks/utils/allowedHttpLinks.txt +++ b/tools/checks/utils/allowedHttpLinks.txt @@ -76,6 +76,7 @@ https://docs.python.org/3/library/base64.html https://docs.python.org/3/library/hashlib.html https://drobotscompany.com/technology-and-coding-stem-camps-kids-summer-camps-for-ages-8-to-13/ https://dushanbe.alg.academy/ +https://editor.swagger.io/ https://edmo.org/ https://empirecode.co/ https://era-it-center.ru/roblox-studio/ @@ -120,6 +121,12 @@ https://github.com/ https://github.com/Elttob/Fusion https://github.com/Roblox/StudioWidgets https://github.com/Roblox/creator-docs +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/cloud.docs.json +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/assets/v1.json +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/ordered-v1.json +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/v1.json +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/messaging-service/v1.json +https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/universes-api/v1.json https://github.com/Roblox/roact/ https://github.com/Roblox/roblox-blender-plugin https://github.com/osyrisrblx/t @@ -158,6 +165,7 @@ https://kodingakademi.id/ https://kodingnext.com/ https://krita.org/ https://krubots.com/ +https://learn.openapis.org/glossary.html https://llama.meta.com/llama3/license/ https://learn.microsoft.com/en-us/style-guide/welcome/ https://learning.ccsso.org/common-core-state-standards-initiative @@ -212,6 +220,7 @@ https://skysmart.ru/programmirovanie-dlya-detej?direction=basics https://small.academy/cursuri/programare-roblox/ https://sopa.tulane.edu/blog/guide-to-protecting-young-online-gamers https://soygenius.com/ +https://spec.openapis.org/oas/v3.0.4 https://start.codabra.org/ https://steameducate.com/ https://steamiowacity.org/ @@ -582,3 +591,4 @@ https://github.com/evaera/roblox-animation-transfer?tab=readme-ov-file#roblosecu https://github.com/evaera/roblox-animation-transfer?tab=readme-ov-file https://github.com/evaera/roblox-animation-transfer https://support.tipalti.com/Content/Topics/UserGuide/PaymentInformation/PaymentMethodsCoverage/IntroUSD.htm?Highlight=payment%20coverage#USD +https://github.com/Roblox/creator-docs/tree/main/content/en-us/reference/cloud