OpenAPI Descriptions

*Este conteúdo estará disponível no idioma selecionado em breve.

The reference pages in the Resources section are rendered from JSON files that are OpenAPI descriptions. These files use version 3.0.4 of the OpenAPI specification.

These files are open source and can be used with tools like the Swagger Editor and Postman 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 repository:

# 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 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.

V1 Resource Specification Extensions

ExtensionLocationDescription
x-roblox-cloud-api-operationOperation ObjectBoolean. Whether the operation is an Open Cloud operation.
x-roblox-cloud-api-operation-nameOperation ObjectString. The name of the operation.
x-roblox-cloud-api-operation-code-samplesOperation ObjectObject. A list of code samples, an object with the language/title and the corresponding script.
x-roblox-cloud-api-operation-throttling-limitOperation ObjectObject. The throttling limits for the operation.

V2 Resource Specification Extensions

ExtensionLocationDescription
x-categoriesOpenAPI ObjectList of strings. All resource categories.
x-visibilityOperation ObjectBoolean. The visibility of the operation.
x-roblox-docsOperation ObjectObject. Associates an operation with a category and resource.
x-long-running-operation-parametersOperation ObjectObject. References the metadata and response for the operation's long running response.
x-oneOfSchema ObjectObject. Each field contains a list of properties in the schema. Only one of the properties should be present.
x-resourceSchema ObjectBoolean. Whether the schema is a resource.
x-immutableSchema ObjectBoolean. Whether the schema is immutable.