cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-07-20 04:22:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation about instance move jobs

Browse Source
This commit is contained in:
Cyberboss
2018-09-04 12:06:01 -04:00
parent c9794a55a2
commit dce16f2109
2 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.dox
+2
View File
@@ -210,6 +210,8 @@ DELETE "/Instance/{InstanceId}" => OK
Some requests return @ref Tgstation.Server.Api.Models.Job objects. These are long running tasks the server will perform asyncronously and can be polled for status.
Note that the job representing instance move operations must be queried and cancelled differently than others. See the documentation of @ref Tgstation.Server.Api.Models.Instance.MoveJob for details
To list all jobs in an Instance use the following request
I GET "/Job/List" => Array of @ref Tgstation.Server.Api.Models.Job