DESIGN doc, stub out /write endpoint

This commit is contained in:
Lucien Greathouse
2017-12-20 22:00:01 -08:00
parent 6ee9a48e20
commit 0f78eb933a
3 changed files with 36 additions and 2 deletions

20
DESIGN.md Normal file
View File

@@ -0,0 +1,20 @@
# Rojo Design
This is a super rough draft that I'm trying to use to lay out of my thoughts.
## API
### POST `/read`
Accepts a `Vec<Route>` of items to read.
Returns `Vec<Option<RbxItem>>`, in the same order as the request.
### POST `/write`
Accepts a `Vec<{ Route, RbxItem }>` of items to write.
I imagine that the `Name` attribute of the top-level `RbxItem` would be ignored in favor of the route name?
## CLI
### Transform Plugins
## Roblox Studio Plugin