Re-document all rights

build/Version.props

@@ -4,8 +4,8 @@
     <!-- Integration tests will ensure they match across the board -->
     <TgsCoreVersion>4.5.1</TgsCoreVersion>
     <TgsConfigVersion>2.1.0</TgsConfigVersion>
-    <TgsApiVersion>7.3.0</TgsApiVersion>
-    <TgsClientVersion>8.3.0</TgsClientVersion>
+    <TgsApiVersion>7.3.1</TgsApiVersion>
+    <TgsClientVersion>8.3.1</TgsClientVersion>
     <TgsDmapiVersion>5.2.4</TgsDmapiVersion>
     <TgsControlPanelVersion>0.4.0</TgsControlPanelVersion>
     <TgsHostWatchdogVersion>1.1.0</TgsHostWatchdogVersion>

src/Tgstation.Server.Api/Rights/AdministrationRights.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Tgstation.Server.Api.Rights
 {
@@ -14,27 +14,27 @@ namespace Tgstation.Server.Api.Rights
 		None = 0,
 
 		/// <summary>
-		/// User can edit themself and other <see cref="Models.User"/>s and also create others
+		/// User can edit their and other <see cref="Models.User"/>s and create new ones.
 		/// </summary>
 		WriteUsers = 1,
 
 		/// <summary>
-		/// User can gracefully restart the host
+		/// User can gracefully restart TGS.
 		/// </summary>
 		RestartHost = 2,
 
 		/// <summary>
-		/// User can change <see cref="Models.Administration.NewVersion"/>
+		/// User can upgrade or downgrade TGS through the API.
 		/// </summary>
 		ChangeVersion = 4,
 
 		/// <summary>
-		/// User can change their password
+		/// User can change their password.
 		/// </summary>
 		EditOwnPassword = 8,
 
 		/// <summary>
-		/// User can read info and rights of other users
+		/// User can read info and rights of other users.
 		/// </summary>
 		ReadUsers = 16,
 

src/Tgstation.Server.Api/Rights/ByondRights.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Tgstation.Server.Api.Rights
 {
@@ -9,32 +9,32 @@ namespace Tgstation.Server.Api.Rights
 	public enum ByondRights : ulong
 	{
 		/// <summary>
-		/// User has no rights
+		/// User has no rights.
 		/// </summary>
 		None = 0,
 
 		/// <summary>
-		/// User may check the active installed BYOND version
+		/// User may view the active installed BYOND version.
 		/// </summary>
 		ReadActive = 1,
 
 		/// <summary>
-		/// User may list all installed BYOND versions
+		/// User may list all installed BYOND versions.
 		/// </summary>
 		ListInstalled = 2,
 
 		/// <summary>
-		/// User may change the active BYOND version. Also allows installing official BYOND versions
+		/// User may install official BYOND versions or change the active BYOND version.
 		/// </summary>
 		InstallOfficialOrChangeActiveVersion = 4,
 
 		/// <summary>
-		/// User may cancel version installations
+		/// User may cancel BYOND installation job.
 		/// </summary>
 		CancelInstall = 8,
 
 		/// <summary>
-		/// User may upload custom BYOND versions
+		/// User may upload and activate custom BYOND builds.
 		/// </summary>
 		InstallCustomVersion = 16,
 	}

src/Tgstation.Server.Api/Rights/ChatBotRights.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Tgstation.Server.Api.Rights
 {
@@ -9,22 +9,22 @@ namespace Tgstation.Server.Api.Rights
 	public enum ChatBotRights : ulong
 	{
 		/// <summary>
-		/// User has no rights
+		/// User has no rights.
 		/// </summary>
 		None = 0,
 
 		/// <summary>
-		/// User can change <see cref="Models.Internal.ChatBot.Enabled"/>
+		/// User can change <see cref="Models.Internal.ChatBot.Enabled"/>.
 		/// </summary>
 		WriteEnabled = 1,
 
 		/// <summary>
-		/// User can change <see cref="Models.Internal.ChatBot.Provider"/>
+		/// User can change <see cref="Models.Internal.ChatBot.Provider"/>.
 		/// </summary>
 		WriteProvider = 2,
 
 		/// <summary>
-		/// User can change <see cref="Models.ChatBot.Channels"/>
+		/// User can change <see cref="Models.ChatBot.Channels"/>.
 		/// </summary>
 		WriteChannels = 4,
 
@@ -34,37 +34,37 @@ namespace Tgstation.Server.Api.Rights
 		WriteConnectionString = 8,
 
 		/// <summary>
-		/// User can read <see cref="Models.Internal.ChatBot.ConnectionString"/> requires <see cref="Read"/>
+		/// User can read <see cref="Models.Internal.ChatBot.ConnectionString"/> requires the <see cref="Read"/> permission.
 		/// </summary>
 		ReadConnectionString = 16,
 
 		/// <summary>
-		/// User can read all chat settings except <see cref="Models.Internal.ChatBot.ConnectionString"/>
+		/// User can read all <see cref="Models.ChatBot"/> properties except <see cref="Models.Internal.ChatBot.ConnectionString"/>
 		/// </summary>
 		Read = 32,
 
 		/// <summary>
-		/// User can create new <see cref="Models.ChatBot"/>
+		/// User can create new <see cref="Models.ChatBot"/>s.
 		/// </summary>
 		Create = 64,
 
 		/// <summary>
-		/// User can delete <see cref="Models.ChatBot"/>
+		/// User can delete <see cref="Models.ChatBot"/>s.
 		/// </summary>
 		Delete = 128,
 
 		/// <summary>
-		/// User can change <see cref="Models.Internal.ChatBot.Name"/>
+		/// User can change <see cref="Models.Internal.ChatBot.Name"/>.
 		/// </summary>
 		WriteName = 256,
 
 		/// <summary>
-		/// User can change <see cref="Models.Internal.ChatBot.ReconnectionInterval"/>
+		/// User can change <see cref="Models.Internal.ChatBot.ReconnectionInterval"/>.
 		/// </summary>
 		WriteReconnectionInterval = 512,
 
 		/// <summary>
-		/// User can change <see cref="Models.Internal.ChatBot.ChannelLimit"/>
+		/// User can change <see cref="Models.Internal.ChatBot.ChannelLimit"/>.
 		/// </summary>
 		WriteChannelLimit = 1024,
 	}

src/Tgstation.Server.Api/Rights/ConfigurationRights.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Tgstation.Server.Api.Rights
 {
@@ -9,27 +9,27 @@ namespace Tgstation.Server.Api.Rights
 	public enum ConfigurationRights : ulong
 	{
 		/// <summary>
-		/// User has no rights
+		/// User has no rights.
 		/// </summary>
 		None = 0,
 
 		/// <summary>
-		/// User may read files
+		/// User may read files if the <see cref="Models.Instance"/> allows it.
 		/// </summary>
 		Read = 1,
 
 		/// <summary>
-		/// User may write files
+		/// User may write files if the <see cref="Models.Instance"/> allows it.
 		/// </summary>
 		Write = 2,
 
 		/// <summary>
-		/// User may list files
+		/// User may list files if the <see cref="Models.Instance"/> allows it.
 		/// </summary>
 		List = 4,
 
 		/// <summary>
-		/// User may delete empty folders
+		/// User may delete empty folders if the <see cref="Models.Instance"/> allows it.
 		/// </summary>
 		Delete = 8
 	}

src/Tgstation.Server.Api/Rights/DreamDaemonRights.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Tgstation.Server.Api.Rights
 {
@@ -34,7 +34,7 @@ namespace Tgstation.Server.Api.Rights
 		SetSecurity = 8,
 
 		/// <summary>
-		/// User can read all ports, <see cref="Models.DreamDaemon.SoftRestart"/>, <see cref="Models.DreamDaemon.SoftShutdown"/>, <see cref="Models.DreamDaemon.Status"/>, <see cref="Models.Internal.DreamDaemonLaunchParameters.AllowWebClient"/>, and <see cref="Models.Internal.DreamDaemonSettings.AutoStart"/>
+		/// User can read every propery of <see cref="Models.DreamDaemon"/> except <see cref="Models.DreamDaemon.ActiveCompileJob"/> and <see cref="Models.DreamDaemon.StagedCompileJob"/>.
 		/// </summary>
 		ReadMetadata = 16,
 
@@ -44,27 +44,27 @@ namespace Tgstation.Server.Api.Rights
 		SetWebClient = 32,
 
 		/// <summary>
-		/// User can change <see cref="Models.DreamDaemon.SoftRestart"/>
+		/// User can change <see cref="Models.DreamDaemon.SoftRestart"/>.
 		/// </summary>
 		SoftRestart = 64,
 
 		/// <summary>
-		/// User can change <see cref="Models.DreamDaemon.SoftShutdown"/>
+		/// User can change <see cref="Models.DreamDaemon.SoftShutdown"/>.
 		/// </summary>
 		SoftShutdown = 128,
 
 		/// <summary>
-		/// User can immediately restart <see cref="Models.DreamDaemon"/>
+		/// User can immediately restart the Watchdog.
 		/// </summary>
 		Restart = 256,
 
 		/// <summary>
-		/// User can immediately shutdown <see cref="Models.DreamDaemon"/>
+		/// User can immediately shutdown the Watchdog.
 		/// </summary>
 		Shutdown = 512,
 
 		/// <summary>
-		/// User can start <see cref="Models.DreamDaemon"/>.
+		/// User can start the Watchdog.
 		/// </summary>
 		Start = 1024,
 

src/Tgstation.Server.Api/Rights/DreamMakerRights.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Tgstation.Server.Api.Rights
 {
@@ -9,42 +9,42 @@ namespace Tgstation.Server.Api.Rights
 	public enum DreamMakerRights : ulong
 	{
 		/// <summary>
-		/// User has no rights
+		/// User has no rights.
 		/// </summary>
 		None = 0,
 
 		/// <summary>
-		/// User may read <see cref="Models.DreamMaker"/> status
+		/// User may read all properties of <see cref="Models.DreamMaker"/>.
 		/// </summary>
 		Read = 1,
 
 		/// <summary>
-		/// User may trigger compiles
+		/// User may trigger deployments.
 		/// </summary>
 		Compile = 2,
 
 		/// <summary>
-		/// User may cancel compiles
+		/// User may cancel deployment jobs.
 		/// </summary>
 		CancelCompile = 4,
 
 		/// <summary>
-		/// User may modify <see cref="Models.DreamMaker.ProjectName"/>
+		/// User may modify <see cref="Models.DreamMaker.ProjectName"/>.
 		/// </summary>
 		SetDme = 8,
 
 		/// <summary>
-		/// User may modify <see cref="Models.DreamMaker.ApiValidationPort"/>
+		/// User may modify <see cref="Models.DreamMaker.ApiValidationPort"/>.
 		/// </summary>
 		SetApiValidationPort = 16,
 
 		/// <summary>
-		/// User may list and read all <see cref="Models.CompileJob"/>s
+		/// User may list and read all <see cref="Models.CompileJob"/>s.
 		/// </summary>
 		CompileJobs = 32,
 
 		/// <summary>
-		/// User may modify <see cref="Models.DreamMaker.ApiValidationSecurityLevel"/>
+		/// User may modify <see cref="Models.DreamMaker.ApiValidationSecurityLevel"/>.
 		/// </summary>
 		SetSecurityLevel = 64,
 

src/Tgstation.Server.Api/Rights/InstanceManagerRights.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Tgstation.Server.Api.Rights
 {
@@ -9,62 +9,62 @@ namespace Tgstation.Server.Api.Rights
 	public enum InstanceManagerRights : ulong
 	{
 		/// <summary>
-		/// User has no rights
+		/// User has no rights.
 		/// </summary>
 		None = 0,
 
 		/// <summary>
-		/// User can view <see cref="Models.Instance"/>s which they have any rights for
+		/// User can view <see cref="Models.Instance"/>s which they have an <see cref="Models.InstanceUser"/> for.
 		/// </summary>
 		Read = 1,
 
 		/// <summary>
-		/// User can create <see cref="Models.Instance"/>s
+		/// User can create <see cref="Models.Instance"/>s.
 		/// </summary>
 		Create = 2,
 
 		/// <summary>
-		/// User can rename <see cref="Models.Instance"/>s they can view
+		/// User can rename <see cref="Models.Instance"/>s they can view.
 		/// </summary>
 		Rename = 4,
 
 		/// <summary>
-		/// User can relocate <see cref="Models.Instance"/>s they can view
+		/// User can relocate <see cref="Models.Instance"/>s they can view.
 		/// </summary>
 		Relocate = 8,
 
 		/// <summary>
-		/// User can online <see cref="Models.Instance"/>s they can view
+		/// User can online <see cref="Models.Instance"/>s they can view.
 		/// </summary>
 		SetOnline = 16,
 
 		/// <summary>
-		/// User can delete <see cref="Models.Instance"/>s they can view
+		/// User can delete <see cref="Models.Instance"/>s they can view.
 		/// </summary>
 		Delete = 32,
 
 		/// <summary>
-		/// User can view all <see cref="Models.Instance"/>s
+		/// User can view all <see cref="Models.Instance"/>s.
 		/// </summary>
 		List = 64,
 
 		/// <summary>
-		/// User can change <see cref="Models.Instance.ConfigurationType"/>
+		/// User can change <see cref="Models.Instance.ConfigurationType"/> on instances they can view.
 		/// </summary>
 		SetConfiguration = 128,
 
 		/// <summary>
-		/// User can change <see cref="Models.Instance.AutoUpdateInterval"/>
+		/// User can change <see cref="Models.Instance.AutoUpdateInterval"/> on instances they can view.
 		/// </summary>
 		SetAutoUpdate = 256,
 
 		/// <summary>
-		/// User can change <see cref="Models.Instance.ChatBotLimit"/>.
+		/// User can change <see cref="Models.Instance.ChatBotLimit"/> on instances they can view.
 		/// </summary>
 		SetChatBotLimit = 512,
 
 		/// <summary>
-		/// User can give themselves full <see cref="Models.InstanceUser"/> rights on instances.
+		/// User can give themselves full <see cref="Models.InstanceUser"/> rights on ALL instances.
 		/// </summary>
 		GrantPermissions = 1024,
 	}

src/Tgstation.Server.Api/Rights/InstanceUserRights.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 
 namespace Tgstation.Server.Api.Rights
 {
@@ -9,22 +9,22 @@ namespace Tgstation.Server.Api.Rights
 	public enum InstanceUserRights : ulong
 	{
 		/// <summary>
-		/// User has no rights
+		/// User has no rights/
 		/// </summary>
 		None = 0,
 
 		/// <summary>
-		/// Allow read access to <see cref="Models.InstanceUser"/> for the <see cref="Models.Instance"/>
+		/// Allow read access to all <see cref="Models.InstanceUser"/>s in the <see cref="Models.Instance"/>.
 		/// </summary>
 		ReadUsers = 1,
 
 		/// <summary>
-		/// Allow write and delete access to <see cref="Models.InstanceUser"/> for the <see cref="Models.Instance"/>
+		/// Allow write and delete access to all <see cref="Models.InstanceUser"/> for the <see cref="Models.Instance"/>.
 		/// </summary>
 		WriteUsers = 2,
 
 		/// <summary>
-		/// Allow adding additional <see cref="Models.InstanceUser"/> to the <see cref="Models.Instance"/>
+		/// Allow adding additional <see cref="Models.InstanceUser"/>s to the <see cref="Models.Instance"/>.
 		/// </summary>
 		CreateUsers = 4
 	}

src/Tgstation.Server.Api/Rights/RepositoryRights.cs

@@ -9,37 +9,37 @@ namespace Tgstation.Server.Api.Rights
 	public enum RepositoryRights : ulong
 	{
 		/// <summary>
-		/// User has no rights
+		/// User has no rights.
 		/// </summary>
 		None = 0,
 
 		/// <summary>
-		/// User may cancel update operations.
+		/// User may cancel repository jobs excluding clone operations.
 		/// </summary>
 		CancelPendingChanges = 1,
 
 		/// <summary>
-		/// User may create the <see cref="Models.Repository"/> if it does not exist
+		/// User may clone the <see cref="Models.Repository"/> if it does not exist.
 		/// </summary>
 		SetOrigin = 2,
 
 		/// <summary>
-		/// User may directly set the sha the <see cref="Models.Repository"/>'s HEAD points to
+		/// User may directly checkout a git SHA that the <see cref="Models.Repository"/>'s HEAD will point to.
 		/// </summary>
 		SetSha = 4,
 
 		/// <summary>
-		/// User may fetch and merge GitHub pull requests
+		/// User may fetch and merge GitHub pull requests.
 		/// </summary>
 		MergePullRequest = 8,
 
 		/// <summary>
-		/// User may use the update feature
+		/// User may fetch and hard reset to the origin version of the current branch.
 		/// </summary>
 		UpdateBranch = 16,
 
 		/// <summary>
-		/// User may change <see cref="Models.Internal.RepositorySettings.CommitterName"/> and <see cref="Models.Internal.RepositorySettings.CommitterEmail"/>
+		/// User may change <see cref="Models.Internal.RepositorySettings.CommitterName"/> and <see cref="Models.Internal.RepositorySettings.CommitterEmail"/>.
 		/// </summary>
 		ChangeCommitter = 32,
 
@@ -49,32 +49,32 @@ namespace Tgstation.Server.Api.Rights
 		ChangeTestMergeCommits = 64,
 
 		/// <summary>
-		/// User may read and change <see cref="Models.Internal.RepositorySettings.AccessUser"/> and <see cref="Models.Internal.RepositorySettings.AccessToken"/>
+		/// User may read and change <see cref="Models.Internal.RepositorySettings.AccessUser"/> and <see cref="Models.Internal.RepositorySettings.AccessToken"/>.
 		/// </summary>
 		ChangeCredentials = 128,
 
 		/// <summary>
-		/// User may set <see cref="Models.Repository.Reference"/> to another git reference (not a SHA)
+		/// User may set <see cref="Models.Repository.Reference"/> to another git branch or tag (not a SHA).
 		/// </summary>
 		SetReference = 256,
 
 		/// <summary>
-		/// User may read all fields in the <see cref="Models.Repository"/> with the exception of <see cref="Models.Internal.RepositorySettings.AccessToken"/>
+		/// User may read all fields in the <see cref="Models.Repository"/> with the exception of <see cref="Models.Internal.RepositorySettings.AccessToken"/>.
 		/// </summary>
 		Read = 512,
 
 		/// <summary>
-		/// User may change <see cref="Models.Internal.RepositorySettings.AutoUpdatesKeepTestMerges"/> and  <see cref="Models.Internal.RepositorySettings.AutoUpdatesSynchronize"/>
+		/// User may change <see cref="Models.Internal.RepositorySettings.AutoUpdatesKeepTestMerges"/> and <see cref="Models.Internal.RepositorySettings.AutoUpdatesSynchronize"/>.
 		/// </summary>
 		ChangeAutoUpdateSettings = 1024,
 
 		/// <summary>
-		/// User may delete the <see cref="Models.Repository"/>
+		/// User may delete the <see cref="Models.Repository"/> and allow it to be cloned again.
 		/// </summary>
 		Delete = 2048,
 
 		/// <summary>
-		/// User may cancel clone operations
+		/// User may cancel clone jobs.
 		/// </summary>
 		CancelClone = 4096
 	}