Spec

Routing

(TODO: write by swagger)

Currently, all of these API are used by client-side program. No public API for other services.

Method	URL	Req Body	Res Body	Description	Guest	General	Admin
GET	/api/1/search/:query		[SearchResult]		✓	✓	✓
GET	/api/1/auth		User		✓	✓	✓
GET	/api/1/people		[Person]		✓	✓	✓
GET	/api/1/people/:personId		Person		✓	✓	✓
GET	/api/1/candidates/:name		[Person]		✓	✓	✓
GET	/api/1/colors		[Color]		✓	✓	✓
GET	/api/1/prototypes		[Prototype]		✓	✓	✓
PUT	/api/1/prototypes/:id	Prototype					✓
DELETE	/api/1/prototypes/:id						✓
GET	/api/1/floors		[FloorInfo]		✓	✓	✓
GET	/api/1/floors?all=true		[FloorInfo]		✓	✓	✓
GET	/api/1/floors/:id		Floor	fetch latest version	✓	✓	✓
GET	/api/1/floors/:id?all=true		Floor	fetch latest unpublished version		✓	✓
PUT	/api/1/floors/:id	FloorChange	Floor	update latest unpublished version		✓	✓
PUT	/api/1/floors/:id/public		Floor	publish latest unpublished version			✓
PUT	/api/1/images/:id	Image					✓

Type	Structure
User	{ id : UUID, name : Person.name, role : Role, personId : String }
Floor	{ id : UUID, ord : Int, version : Int, name : String, image? : URL, realSize? : (Int, Int), objects : [ Object ], public : Bool, publishedBy? : User.id, publishedAt? : Date }
FloorChange	{ id : UUID, ord : Int, version : Int, name : String, image? : URL, realSize? : (Int, Int), add : [ Object ], modify : [ (Object, Object) ], delete : [ Object ], public : Bool, publishedBy? : User.id, publishedAt? : Date }
Object	{ id : UUID, type: String, name : String, size : (Int, Int), color : String, fontSize : Float, shape : String, personId? : String }
Prototype	{ id : UUID, name : String, size : (Int, Int), color : String }
Image	Binary
SearchResult	[(Object, String)]
Person	{ id : String, name : String, post : String, tel? : String, mail? : String, image? : URL }
Role	"admin" "general"
Color	{ id : String, ord : Int, type : String, color : String }
UUID	String
Date	Int
URL	String

See here.