Deskripsi OpenAPI

*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

Halaman referensi di bagian Open Cloud v2 dan Open Cloud v1 ditampilkan dari file JSON yang merupakan deskripsi OpenAPI.File-file ini menggunakan versi 3.0.4 dari spesifikasi OpenAPI.

File-file ini adalah sumber terbuka dan dapat digunakan dengan alat seperti Editor Swagger dan Postman untuk menguji panggilan API dan membantu mengotomatisasi pengembangan.

Deskripsi OpenAPI ini masih dalam pengembangan aktif dan mungkin berisi masalah.Halaman di bawah bagian Sumber daya adalah referensi resmi.

File deskripsi API terbuka

File deskripsi OpenAPI tersedia di lokasi berikut dalam repositori dokumen pencipta:

# 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

Ekstensi penjual

Roblox menggunakan ekstensi spesifikasi untuk memperluas spesifikasi OpenAPI untuk memperluas spesifikasi OpenAPI.Ekstensi ini mewakili informasi yang spesifikasi tidak menangkap secara default.Ekstensi dapat muncul di seluruh file di mana diizinkan oleh spesifikasi OpenAPI.

Mayoritas ekstensi spesifikasi ini adalah eksperimental.Ekstensi yang digunakan bersifat dapat berubah tanpa pemberitahuan demi bidang yang ditemukan dalam spesifikasi OpenAPI resmi.

Ekstensi spesifikasi sumber daya V2

EkstensiLokasiDeskripsi
x-categoriesObjek OpenAPIDaftar string.Semua kategori sumber daya.
x-visibilityObjek OperasiBoolean.Keterlihatan operasi.
x-roblox-docsObjek OperasiObjek.Hubungkan operasi dengan kategori dan sumber daya.
x-long-running-operation-parametersObjek OperasiObjek.Referensikan metadata dan respons untuk respons jangka panjang operasi.
x-aep-resourceObjek SkemaObjek.Ekstensi yang mencatat ketiksumber daya.Memiliki kompatibilitas dekat dengan AEP-4 , salah satu proposal Peningkatan API.
x-oneOfObjek SkemaObjek.Setiap bidang berisi daftar properti dalam skema.Hanya satu dari properti harus hadir.
x-resourceObjek SkemaBoolean.Apakah skema adalah sumber daya.
x-immutableObjek SkemaBoolean.Apakah skema tidak dapat diubah.

Ekstensi spesifikasi sumber daya V1

EkstensiLokasiDeskripsi
x-roblox-cloud-api-operationOperasi ObjekBoolean.Apakah operasi adalah operasi Cloud Terbuka.
x-roblox-cloud-api-operation-nameObjek OperasiString.Nama operasi.
x-roblox-cloud-api-operation-code-samplesObjek OperasiObjek.Daftar sampel kode, objek dengan bahasa/judul dan skrip yang sesuai.
x-roblox-cloud-api-operation-throttling-limitObjek OperasiObjek.Batas pengurangan untuk operasi.