Update documentation about instance move jobs

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
+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
@@ -46,6 +46,7 @@ namespace Tgstation.Server.Api.Models
/// <summary>
/// The <see cref="Job"/> representing a change of <see cref="Path"/>
/// </summary>
/// <remarks>Due to how <see cref="Job"/>s are children of <see cref="Instance"/>s but moving one requires the <see cref="Instance"/> to be offline, interactions with this <see cref="Job"/> are performed in a non-standard fashion. The <see cref="Job"/> is read by querying the <see cref="Instance"/> again (either via list or ID lookup) and cancelled by making any sort of update to the <see cref="Instance"/>. Once the <see cref="Instance"/> comes back <see cref="Online"/> it can be queried like a normal job</remarks>
[NotMapped]
public Job MoveJob { get; set; }