Module web_api

Module web_api 

Source
Expand description

Defines all the structs needed to interact with the Rojo Serve API. This is useful for tests to be able to use the same data structures as the implementation.

Structs§

BufferEncode
Using this struct we can force Roblox to JSONDecode this as a buffer. This is what Roblox’s serde APIs use, so it saves a step in the plugin.
ErrorResponse
General response type returned from all Rojo routes
Instance
InstanceMetadata
InstanceUpdate
OpenResponse
Response body from /api/open/{id}
ReadResponse
Response body from /api/read/{id}
RefPatchResponse
SerializeResponse
ServerInfoResponse
Response body from /api/rojo
SubscribeMessage
Message returned by Rojo API when a change has occurred.
SubscribeResponse
Response body from /api/subscribe/{cursor}
WriteRequest
WriteResponse

Enums§

ErrorResponseKind

Constants§

PROTOCOL_VERSION
Current protocol version, which is required to match.