cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-27 23:17:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Compiler docs

Browse Source
This commit is contained in:
Cyberboss
2018-08-10 14:32:37 -04:00
parent dc4ea3d599
commit a83e63c4d4
1 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.dox
+24
View File
@@ -340,4 +340,28 @@ The repository uses the @ref Tgstation.Server.Api.Models.Repository.AccessUser a
This will remove both fields from the database
@subsection api_dm Compiler Handling
The DM compiler can run one job at a time for an Instance. Instead of using standard @ref Tgstation.Server.Api.Models.Job.Progress it uses the @ref Tgstation.Server.Api.Models.DreamMaker.Status field to denote it's current stage. It can be retrieved like this:
I GET "/DreamMaker" => @ref Tgstation.Server.Api.Models.DreamMaker
This will also return the last successful @ref Tgstation.Server.Api.Models.CompileJob as well as the @ref Tgstation.Server.Api.Models.Internal.DreamMakerSettings.ProjectName
The ProjectName field can be changed with this method:
I POST "/DreamMaker" @ref Tgstation.Server.Api.Models.DreamMaker => @ref Tgstation.Server.Api.Models.DreamMaker
To start a compile job use the following request:
I PUT "/DreamMaker" Empty => @ref Tgstation.Server.Api.Models.Job
The job object returned represents the compile job
"Empty" refers to an empty json object like so:
@code{.json}
{}
@endcode
*/