From dce16f210916ec424efe6de1c759f303178e48ef Mon Sep 17 00:00:00 2001
From: Cyberboss <Cyberboss@users.noreply.github.com>
Date: Tue, 4 Sep 2018 12:06:01 -0400
Subject: [PATCH] Update documentation about instance move jobs

---
 docs/API.dox                                | 2 ++
 src/Tgstation.Server.Api/Models/Instance.cs | 1 +
 2 files changed, 3 insertions(+)

diff --git a/docs/API.dox b/docs/API.dox
index af9deb1ebe..ddc5028bd4 100644
--- a/docs/API.dox
+++ b/docs/API.dox
@@ -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
diff --git a/src/Tgstation.Server.Api/Models/Instance.cs b/src/Tgstation.Server.Api/Models/Instance.cs
index 474016bacb..0349ce9fce 100644
--- a/src/Tgstation.Server.Api/Models/Instance.cs
+++ b/src/Tgstation.Server.Api/Models/Instance.cs
@@ -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; }