Las páginas de referencia en las secciones Open Cloud v2 y Open Cloud v1 se renderizan a partir de archivos JSON que son descripciones de OpenAPI.Estos archivos usan la versión 3.0.4 de la especificación de OpenAPI.
Estos archivos son de código abierto y se pueden utilizar con herramientas como el Editor de Swagger y Postman para probar llamadas de API y ayudar a simplificar el desarrollo.
Estas descripciones de OpenAPI todavía están en desarrollo activo y pueden contener problemas.Las páginas de la sección Recursos son la referencia oficial.
Archivos de descripción de OpenAPI
Los archivos de descripción de OpenAPI están disponibles en los siguientes lugares dentro del repositorio creator-docs:
Extensiones de vendedor
Roblox usa extensiones de especificación para extender la especificación de OpenAPI.Estas extensiones representan información que la especificación no captura por defecto.Las extensiones pueden aparecer a lo largo del archivo donde se permita por la especificación de OpenAPI.
La mayoría de estas extensiones de especificación son experimentales.Las extensiones utilizadas están sujetas a cambios sin previo aviso a favor de los campos encontrados dentro de la especificación oficial de OpenAPI.
Las descripciones de OpenAPI para recursos V1 y V2 utilizan extensiones de especificación distintas debido a diferencias de implementación subyacentes.
Extensión de especificación de recursos V2
| Extensión | Ubicación | Descripción |
|---|---|---|
| x-categories | Objeto de OpenAPI | Lista de cadenas.Todas las categorías de recursos. |
| x-visibility | Objeto de operación | Boolean.La visibilidad de la operación. |
| x-roblox-docs | Objeto de operación | Objeto.Asocia una operación con una categoría y un recurso. |
| x-long-running-operation-parameters | Objeto de operación | Objeto.Se refiere a los metadatos y la respuesta para la respuesta de larga duración de la operación. |
| x-aep-resource | Objeto esquema | Objeto.Una extensión que anota el introducirde recurso.Tiene compatibilidad cercana con AEP-4 , una de las propuestas de mejora de la API . |
| x-oneOf | Objeto esquema | Objeto.Cada campo contiene una lista de propiedades en el esquema.Solo una de las propiedades debe estar presente. |
| x-resource | Objeto esquema | Booleano.Si el esquema es un recurso. |
| x-immutable | Objeto esquema | Booleano.Si el esquema es inmutable. |
Extensión de especificación de recursos V1
| Extensión | Ubicación | Descripción |
|---|---|---|
| x-roblox-cloud-api-operation | Objeto de operación | Boolean.Si la operación es una operación de nube abierta. |
| x-roblox-cloud-api-operation-name | Objeto de operación | String.El nombre de la operación. |
| x-roblox-cloud-api-operation-code-samples | Objeto de operación | Objeto.Una lista de muestras de código, un objeto con el idioma/título y el script correspondiente. |
| x-roblox-cloud-api-operation-throttling-limit | Objeto de operación | Objeto.Los límites de aceleración para la operación. |