Tgstation.Server.Api.Models Namespace Reference

Namespaces
namespace	Internal
namespace	Request
namespace	Response

Classes
class	ChatChannel
	Indicates a chat channel. More...
class	DiscordConnectionStringBuilder
	ChatConnectionStringBuilder for ChatProvider.Discord. More...
class	EngineVersion
	Information about an engine installation. More...
class	EntityId
	Common base of entities with IDs. More...
class	ErrorCodeExtensions
	Extension methods for the ErrorCode enum. More...
interface	IConfigurationFile
	Represents a game configuration file. Create and delete actions uncerimonuously overwrite/delete files. More...
class	Instance
	Metadata about a server instance. More...
class	IrcConnectionStringBuilder
	ChatConnectionStringBuilder for ChatProvider.Irc. More...
class	Limits
	Sanity limits to prevent users from overloading. More...
class	NamedEntity
	Base class for named entities. More...
class	OAuthConnection
	Represents a valid OAuth connection. More...
class	OAuthProviderInfo
	Public information about a given OAuthProvider. More...
class	PermissionSet
	Represents a set of server permissions. More...
class	RepositorySettings
	Represents configurable settings for a git repository. More...
class	RequestOptionsAttribute
	Indicates the FieldPresence for fields in models. More...
class	ResponseOptionsAttribute
	Indicates the response FieldPresence of API fields. Changes it from FieldPresence.Required to FieldPresence.Optional by default. More...
class	RevisionInformation
class	TestMerge
class	TestMergeParameters
	Parameters for creating a TestMerge. More...
class	UserName
	Base class for user names. More...

Enumerations
enum	ChatProvider { Irc , Discord }
	Represents a chat service provider. More...
enum	ConfigurationType { Disallowed , HostWrite , SystemIdentityWrite }
	The type of configuration allowed on an Instance. More...
enum	DiscordDMOutputDisplayType { Always , OnError , Never }
	When the DM output section of Discord deployment embeds should be shown. More...
enum	DMApiValidationMode { Optional , Required , Skipped }
	The DMAPI validation setting for deployments. More...
enum	DreamDaemonSecurity { Trusted , Safe , Ultrasafe }
	DreamDaemon's security level. More...
enum	DreamDaemonVisibility { Public , Private , Invisible }
	The visibility setting for DreamDaemon. More...
enum	EngineType { Byond , OpenDream }
	The type of engine the codebase is using. More...
enum	ErrorCode : uint {   InternalServerError , ApiMismatch , ModelValidationFailure , IOError ,   BadHeaders , TokenWithToken , DatabaseIntegrityConflict , MissingHostWatchdog ,   CannotChangeServerSuite , RemoteApiError , ServerUpdateInProgress , UserNameChange ,   UserSidChange , UserMismatchNameSid , UserMismatchPasswordSid , UserPasswordLength ,   UserColonInName , UserMissingName , InstanceRelocateOnline , InstanceAtExistingPath ,   InstanceDetachOnline , InstanceAtConflictingPath , InstanceLimitReached , InstanceWhitespaceNameOrPath ,   InstanceHeaderRequired , RequiresPosixSystemIdentity , ConfigurationFileUpdated , ConfigurationDirectoryNotEmpty ,   SwarmIntegrityCheckFailed , RepoMismatchUserAndAccessToken , RepoCloning , RepoBusy ,   RepoExists , RepoMissing , RepoMismatchShaAndReference , RepoMismatchShaAndUpdate ,   EngineCannotDeleteActiveVersion , RepoDuplicateTestMerge , RepoWhitespaceCommitterName , RepoWhitespaceCommitterEmail ,   ApiPageTooLarge , ApiInvalidPageOrPageSize , ChatBotWrongChannelType , ChatBotWhitespaceConnectionString ,   ChatBotWhitespaceName , ChatBotProviderMissing , ConfigurationContendedAccess , ChatBotMax ,   ChatBotMaxChannels , ByondDirectXInstallFail , EngineDownloadFail , EngineNoVersionsInstalled ,   DeploymentNeverValidated , DeploymentInvalidValidation , CannotRemoveLastAuthenticationOption , DeploymentNoDme ,   DeploymentMissingDme , DeploymentExitCode , DeploymentInProgress , InstanceMissingDreamDaemonSettings ,   InstanceMissingDreamMakerSettings , InstanceMissingRepositorySettings , InstanceUpdateTestMergeConflict , RepoCredentialsRequired ,   RepoCannotAuthenticate , RepoReferenceRequired , WatchdogRunning , WatchdogCompileJobCorrupted ,   WatchdogStartupFailed , WatchdogStartupTimeout , RepoUnsupportedTestMergeRemote , RepoSwappedShaOrReference ,   RepoMergeConflict , RepoReferenceNotTracking , RepoTestMergeConflict , InstanceNotAtWhitelistedPath ,   GameServerDoubleSoft , DreamDaemonPagerRunning , GameServerPortInUse , PostDeployFailure ,   WatchdogNotRunning , ResourceNotPresent , ResourceNeverPresent , GitHubApiRateLimit ,   JobStopped , MissingGCore , GCoreFailure , RepoTestMergeInvalidRemote ,   EngineNonExistentCustomVersion , GameServerOffline , InstanceOffline , ChatCannotConnectProvider ,   EngineFirewallFail , NoPortsAvailable , PortNotAvailable , AdminUserCannotOAuth ,   OAuthProviderDisabled , FileUploadExpired , UserGroupAndPermissionSet , UserGroupNotEmpty ,   UserLimitReached , UserGroupLimitReached , DeploymentTimeout , BroadcastFailure ,   OpenDreamCantFindDotnet , OpenDreamTooOld , DotnetDiagnosticsFailure , DeploymentWrongDme ,   RepoTokenUsernameMismatch , RemoteGatewaysNotImplemented }
	Types of Response.ErrorMessageResponses that the API may return. More...
enum	FieldPresence { Optional , Required , Ignored }
	Indicates whether a request field is Required or Ignored. More...
enum	IrcPasswordType { Server , Sasl , NickServ , Oper }
	Represents the type of a password for a ChatProvider.Irc. More...
enum	JobCode : byte {   Unknown , Move , RepositoryClone , RepositoryUpdate ,   RepositoryAutoUpdate , RepositoryDelete , EngineOfficialInstall , EngineCustomInstall ,   EngineDelete , Deployment , AutomaticDeployment , WatchdogLaunch ,   WatchdogRestart , WatchdogDump , StartupWatchdogLaunch , StartupWatchdogReattach ,   ReconnectChatBot , RepositoryReclone }
	The different types of Response.JobResponse. More...
enum	OAuthProvider {   GitHub , Discord , TGForums , Keycloak ,   InvisionCommunity }
	List of OAuth providers supported by TGS. More...
enum	RemoteGitProvider { Unknown , GitHub , GitLab }
	Indicates the remote git host. More...
enum	WatchdogStatus { Offline , Restoring , Online , DelayedRestart }
	The current status of the watchdog. More...

Enumeration Type Documentation

ChatProvider

enum Tgstation.Server.Api.Models.ChatProvider

Represents a chat service provider.

Enumerator
Irc	Internet relay chat.
Discord	Superior chat service.

Definition at line 6 of file ChatProvider.cs.

    {
        Irc,
 
        Discord,
    }

ConfigurationType

enum Tgstation.Server.Api.Models.ConfigurationType

The type of configuration allowed on an Instance.

Enumerator
Disallowed	Configuration editing is not allowed.
HostWrite	Configuration editing is allowed by all users on all files.
SystemIdentityWrite	Configuration editing is allowed by only by system identity users and uses their filesystem ACLs.

Definition at line 6 of file ConfigurationType.cs.

    {
        Disallowed,
 
        HostWrite,
 
        SystemIdentityWrite,
    }

DiscordDMOutputDisplayType

enum Tgstation.Server.Api.Models.DiscordDMOutputDisplayType

When the DM output section of Discord deployment embeds should be shown.

Enumerator
Always	Always show.
OnError	Only show if DM failed.
Never	Never show.

Definition at line 6 of file DiscordDMOutputDisplayType.cs.

    {
        Always,
 
        OnError,
 
        Never,
    }

DMApiValidationMode

enum Tgstation.Server.Api.Models.DMApiValidationMode

The DMAPI validation setting for deployments.

Enumerator
Optional	DMAPI validation is performed but not required for the deployment to succeed.
Required	DMAPI validation must suceed for the deployment to succeed.
Skipped	DMAPI validation will not be performed and no DMAPI features will be available in the deployment.

Definition at line 6 of file DMApiValidationMode.cs.

    {
        Optional,
 
        Required,
 
        Skipped,
    }

DreamDaemonSecurity

enum Tgstation.Server.Api.Models.DreamDaemonSecurity

DreamDaemon's security level.

Enumerator
Trusted	Server is unrestricted in terms of file access and shell commands.
Safe	Server will not be able to run shell commands or access files outside it's working directory.
Ultrasafe	Server will not be able to run shell commands or access anything but temporary files.

Definition at line 6 of file DreamDaemonSecurity.cs.

    {
        Trusted,
 
        Safe,
 
        Ultrasafe,
    }

DreamDaemonVisibility

enum Tgstation.Server.Api.Models.DreamDaemonVisibility

The visibility setting for DreamDaemon.

Enumerator
Public	Public DreamDaemon visibility.
Private	Private DreamDaemon visibility.
Invisible	Invisible DreamDaemon visibility.

Definition at line 6 of file DreamDaemonVisibility.cs.

    {
        Public,
 
        Private,
 
        Invisible,
    }

EngineType

enum Tgstation.Server.Api.Models.EngineType

The type of engine the codebase is using.

Enumerator
Byond	Build your own net dream.
OpenDream	The OpenDream BYOND reimplementation.

Definition at line 6 of file EngineType.cs.

    {
        Byond,
 
        OpenDream,
    }

ErrorCode

enum Tgstation.Server.Api.Models.ErrorCode : uint

Types of Response.ErrorMessageResponses that the API may return.

Entries marked Obsolete are no longer in use but kept for placeholders until they can be recycled in the next major API version.

Enumerator
InternalServerError	An implementation error occurred while processing the request.
ApiMismatch	Indicates an API upgrade was required by the server.
ModelValidationFailure	The request body was malformed.
IOError	An IO error occurred while working with the configuration system.
BadHeaders	The ApiHeaders failed to validate.
TokenWithToken	Attempted to request a Response.TokenResponse with an existing Response.TokenResponse.
DatabaseIntegrityConflict	Generic database integrity failure.
MissingHostWatchdog	Attempted to perform a restart operation without the host watchdog component.
CannotChangeServerSuite	Attempted to change to a major version less than 4.
RemoteApiError	A required remote API request failed.
ServerUpdateInProgress	A server update was requested while another was in progress.
UserNameChange	Attempted to change something other than the capitalization of a UserName.Name for a user.
UserSidChange	Attempted to change a Internal.UserModelBase.SystemIdentifier.
UserMismatchNameSid	Attempted to create a user with a UserName.Name and Internal.UserModelBase.SystemIdentifier.
UserMismatchPasswordSid	Attempted to create a user with a Request.UserUpdateRequest.Password and Internal.UserModelBase.SystemIdentifier.
UserPasswordLength	The given Request.UserUpdateRequest.Password length was less than the server's configured minimum.
UserColonInName	Attempted to create a user with a ':' character in the UserName.Name.
UserMissingName	Attempted to create a user with a null or whitespace UserName.Name.
InstanceRelocateOnline	Attempted to change a Instance.Path while it was Instance.Online.
InstanceAtExistingPath	Attempted to change a Instance.Path to a non-empty location.
InstanceDetachOnline	Attempted to detach an Instance while it was Instance.Online.
InstanceAtConflictingPath	Attempted to change a Instance.Path to a location that conflicts with the server install or another instance.
InstanceLimitReached	Attempted to create an Instance but the configured instance limit has been reached.
InstanceWhitespaceNameOrPath	Attempted to create an Instance with a whitespace NamedEntity.Name or Instance.Path.
InstanceHeaderRequired	The ApiHeaders.InstanceIdHeader header was required but not set.
RequiresPosixSystemIdentity	The operation requires the unimplemented POSIX system identities feature.
ConfigurationFileUpdated	A IConfigurationFile was updated.
ConfigurationDirectoryNotEmpty	Attempted to delete an non-empty directory.
SwarmIntegrityCheckFailed	The server swarm has less than the expected amount of nodes.
RepoMismatchUserAndAccessToken	One of RepositorySettings.AccessUser and RepositorySettings.AccessToken is set while the other isn't.
RepoCloning	The repository is busy being cloned.
RepoBusy	The repository is busy with another operation.
RepoExists	Attempted to clone the repository when it already exists.
RepoMissing	Attempted to load a non-existant repo.
RepoMismatchShaAndReference	Attempted to Request.RepositoryUpdateRequest.CheckoutSha and set Internal.RepositoryApiBase.Reference at the same time.
RepoMismatchShaAndUpdate	Attempted to Request.RepositoryUpdateRequest.CheckoutSha and Request.RepositoryUpdateRequest.UpdateFromOrigin at the same time.
EngineCannotDeleteActiveVersion	Could not delete a engine version due to it being set as the active version for the instance.
RepoDuplicateTestMerge	Request.RepositoryUpdateRequest.NewTestMerges contained duplicate TestMergeParameters.Numbers.
RepoWhitespaceCommitterName	Attempted to set a whitespace RepositorySettings.CommitterName.
RepoWhitespaceCommitterEmail	Attempted to set a whitespace RepositorySettings.CommitterEmail.
ApiPageTooLarge	A paginated request asked for too large a page.
ApiInvalidPageOrPageSize	A paginated request asked for page 0.
ChatBotWrongChannelType	A requested ChatChannel's data does not match with its Internal.ChatBotSettings.Provider.
ChatBotWhitespaceConnectionString	Internal.ChatBotSettings.ConnectionString was whitespace.
ChatBotWhitespaceName	Chat bot NamedEntity.Name was whitespace.
ChatBotProviderMissing	Internal.ChatBotSettings.Provider was null during creation.
ConfigurationContendedAccess	Currently unused.
ChatBotMax	Attempted to add a chat bot when at or above the Instance.ChatBotLimit or it was set to something lower than the existing amount of chat bots.
ChatBotMaxChannels	Attempted to configure a chat bot with more ChatChannels than the configured Internal.ChatBotSettings.ChannelLimit.
ByondDirectXInstallFail	Failed to install DirectX with BYOND.
EngineDownloadFail	Failed to download a given engine version.
EngineNoVersionsInstalled	Failed to lock engine executables.
DeploymentNeverValidated	The DMAPI never validated itself.
DeploymentInvalidValidation	The DMAPI sent an invalid validation request.
CannotRemoveLastAuthenticationOption	Tried to remove the last OAuthConnection for a passwordless user.
DeploymentNoDme	No .dme could be found for deployment.
DeploymentMissingDme	The configured .dme could not be found.
DeploymentExitCode	Compiler failed to compile.
DeploymentInProgress	Deployment already in progress.
InstanceMissingDreamDaemonSettings	Missing Internal.DreamDaemonSettings in database.
InstanceMissingDreamMakerSettings	Missing Internal.DreamMakerSettings in database.
InstanceMissingRepositorySettings	Missing RepositorySettings in database.
InstanceUpdateTestMergeConflict	Performing an automatic update with the RepositorySettings.AutoUpdatesKeepTestMerges flag resulted in merge conflicts.
RepoCredentialsRequired	RepositorySettings.AccessUser and RepositorySettings.AccessToken are required for this operation.
RepoCannotAuthenticate	The remote returned an invalid authentication request.
RepoReferenceRequired	Cannot perform operation while not on a Internal.RepositoryApiBase.Reference.
WatchdogRunning	Attempted to start the watchdog when it was already running.
WatchdogCompileJobCorrupted	Attempted to start the watchdog with a corrupted Internal.CompileJob.
WatchdogStartupFailed	Game server exited before it finished starting.
WatchdogStartupTimeout	Game server timed-out before it finished starting.
RepoUnsupportedTestMergeRemote	Attempted to test merge with an unsupported remote.
RepoSwappedShaOrReference	Either Request.RepositoryUpdateRequest.CheckoutSha or Internal.RepositoryApiBase.Reference was in one when it should have been the other.
RepoMergeConflict	A merge conflict occurred during a git operation.
RepoReferenceNotTracking	The current Internal.RepositoryApiBase.Reference does not track a remote reference.
RepoTestMergeConflict	Encounted merge conflicts while test merging.
InstanceNotAtWhitelistedPath	Attempted to create an instance outside of the Internal.ServerInformationBase.ValidInstancePaths.
GameServerDoubleSoft	Attempted to make a game server update with both Internal.DreamDaemonApiBase.SoftRestart and Internal.DreamDaemonApiBase.SoftShutdown set.
DreamDaemonPagerRunning	Attempted to launch DreamDaemon on a user account that had the BYOND pager running.
GameServerPortInUse	Could not bind to port we wanted to launch the game server on.
PostDeployFailure	Failed to post GitHub comments, or send TGS event.
WatchdogNotRunning	Attempted to restart a stopped watchdog.
ResourceNotPresent	Attempted to access a resourse that is not (currently) present.
ResourceNeverPresent	Attempted to access a resource that was never present.
GitHubApiRateLimit	A required GitHub API call failed due to rate limiting.
JobStopped	Attempted to cancel a stopped job.
MissingGCore	Missing GCore executable.
GCoreFailure	Non-zero gcore exit code.
RepoTestMergeInvalidRemote	Attempted to test merge with an invalid remote repository.
EngineNonExistentCustomVersion	Attempted to switch to a custom engine version that does not exist.
GameServerOffline	Attempted to perform an operation that requires server (not the watchdog) to be running but it wasn't.
InstanceOffline	Attempted to perform an instance operation with an offline instance.
ChatCannotConnectProvider	An attempt to connect a chat bot failed.
EngineFirewallFail	Attempt to add DreamDaemon to the list of firewall exempt processes failed.
NoPortsAvailable	Attempted to create an instance but no free ports could be found.
PortNotAvailable	Attempted to set a port which is either in use by another part of TGS or otherwise not available for binding.
AdminUserCannotOAuth	Attempted to set Internal.UserApiBase.OAuthConnections for the admin user.
OAuthProviderDisabled	Attempted to login with a disabled OAuth provider.
FileUploadExpired	A job requiring a file upload did not receive it before timing out.
UserGroupAndPermissionSet	Tried to update a user to have both a Internal.UserApiBase.Group and Internal.UserApiBase.PermissionSet.
UserGroupNotEmpty	Tried to delete a non-empty user group.
UserLimitReached	Attempted to create a user but the configured limit has been reached.
UserGroupLimitReached	Attempted to create a user group but the configured limit has been reached.
DeploymentTimeout	A deployment took longer than the configured timeout.
BroadcastFailure	Sending a broadcast message failed.
OpenDreamCantFindDotnet	Could not compile OpenDream due to a missing dotnet executable.
OpenDreamTooOld	Could not install OpenDream due to it not meeting the minimum version requirements.
DotnetDiagnosticsFailure	Failed dotnet diagnostics dump.
DeploymentWrongDme	The configured .dme could not be found.
RepoTokenUsernameMismatch	Entered wrong RepositorySettings.AccessUser for a RepositorySettings.AccessToken.
RemoteGatewaysNotImplemented	Attempted to make a cross swarm server request using the GraphQL API.

Definition at line 11 of file ErrorCode.cs.

    {
        [Description("An internal server error occurred!")]
        InternalServerError,
 
        [Description("API version mismatch!")]
        ApiMismatch,
 
        [Description("The request body was malformed!")]
        ModelValidationFailure,
 
        [Description("An IO error occurred during the operation!")]
        IOError,
 
        [Description("A header validation error occurred!")]
        BadHeaders,
 
        [Description("Cannot generate a bearer token using a bearer token!")]
        TokenWithToken,
 
        [Description("The operation could not be performed as it would violate database integrity. Please retry the request, making sure to not duplicate field names with existing entities!")]
        DatabaseIntegrityConflict,
 
        [Description("Functionality is unavailable due to a missing host watchdog component! This should NOT be seen in a production environment!")]
        MissingHostWatchdog,
 
        [Description($"Cannot downgrade to {Constants.CanonicalPackageName} major version <4!")]
        CannotChangeServerSuite,
 
        [Description("A required remote API request returned an error!")]
        RemoteApiError,
 
        [Description("A server update was requested while another was in progress!")]
        ServerUpdateInProgress,
 
        [Description("Can only change the capitalization of a user's name!")]
        UserNameChange,
 
        [Description("Cannot change a user's systemIdentifier!")]
        UserSidChange,
 
        [Description("A user cannot have both a name and systemIdentifier!")]
        UserMismatchNameSid,
 
        [Description("A user cannot have both a password and systemIdentifier!")]
        UserMismatchPasswordSid,
 
        [Description("The given password is less than the server's configured minimum password length!")]
        UserPasswordLength,
 
        [Description("User names cannot contain the ':' character!")]
        UserColonInName,
 
        [Description("User's name is missing or invalid whitespace!")]
        UserMissingName,
 
        [Description("Cannot relocate an instance while it is online!")]
        InstanceRelocateOnline,
 
        [Description("The instance cannot be placed at the given path because it is not empty!")]
        InstanceAtExistingPath,
 
        [Description("Cannot detach an instance while it is online!")]
        InstanceDetachOnline,
 
        [Description("The instance cannot be placed at the given path because it is a child of an existing instance or the server installation directory!")]
        InstanceAtConflictingPath,
 
        [Description("The instance cannot be created because the configured limit has been reached!")]
        InstanceLimitReached,
 
        [Description("Instance names and paths cannot be whitespace!")]
        InstanceWhitespaceNameOrPath,
 
        [Description("The request path requires the 'Instance' header to be set!")]
        InstanceHeaderRequired,
 
        [Description("This operation requires POSIX system identities to be implemented. See https://github.com/tgstation/tgstation-server/issues/709 for details.")]
        RequiresPosixSystemIdentity,
 
        [Description("This existing file hash does not match, the file has beeen updated!")]
        ConfigurationFileUpdated,
 
        [Description("The directory cannot be deleted because it is not empty!")]
        ConfigurationDirectoryNotEmpty,
 
        [Description("The server swarm has less than the expected amount of nodes!")]
        SwarmIntegrityCheckFailed,
 
        [Description("Either both accessUser and accessToken must be set or neither!")]
        RepoMismatchUserAndAccessToken,
 
        [Description("The repository is busy being cloned!")]
        RepoCloning,
 
        [Description("The repository is busy with another operation!")]
        RepoBusy,
 
        [Description("The repository already exists!")]
        RepoExists,
 
        [Description("The repository does not exist and must be cloned!")]
        RepoMissing,
 
        [Description("Cannot checkoutSha and set reference at the same time!")]
        RepoMismatchShaAndReference,
 
        [Description("Cannot checkoutSha and updateFromOrigin at the same time!")]
        RepoMismatchShaAndUpdate,
 
        [Description("Could not delete engine version due to it being selected as the instance's active version.")]
        EngineCannotDeleteActiveVersion,
 
        [Description("The same test merge was present more than once or is already merged!")]
        RepoDuplicateTestMerge,
 
        [Description("committerName cannot be whitespace!")]
        RepoWhitespaceCommitterName,
 
        [Description("committerEmail cannot be whitespace!")]
        RepoWhitespaceCommitterEmail,
 
        [Description("Requested pageSize is too large!")]
        ApiPageTooLarge,
 
        [Description("Cannot request page or pageSize <= 0.")]
        ApiInvalidPageOrPageSize,
 
        [Description("One or more of the channels for one or more of the provided chat bots do not have the correct channel data for their provider!")]
        ChatBotWrongChannelType,
 
        [Description("A chat bot's connection string cannot be whitespace!")]
        ChatBotWhitespaceConnectionString,
 
        [Description("A chat bot's name cannot be whitespace!")]
        ChatBotWhitespaceName,
 
        [Description("Missing chat bot provider!")]
        ChatBotProviderMissing,
 
        [Description("IO operation could not start contended access to the instance's configuration directory!")]
        ConfigurationContendedAccess,
 
        [Description("Performing this operation would violate the instance's configured chatBotLimit!")]
        ChatBotMax,
 
        [Description("Set amount of chatChannels exceeds the configured channelLimit!")]
        ChatBotMaxChannels,
 
        [Description("Unable to start DirectX installer process! Is the server running with admin privileges?")]
        ByondDirectXInstallFail,
 
        [Description("Error downloading specified engine version!")]
        EngineDownloadFail,
 
        [Description("Could not acquire lock on engine installation as none exist!")]
        EngineNoVersionsInstalled,
 
        [Description("DMAPI validation failed! See FAQ at https://github.com/tgstation/tgstation-server/discussions/1695")]
        DeploymentNeverValidated,
 
        [Description("The DMAPI sent an invalid validation request!")]
        DeploymentInvalidValidation,
 
        [Description("This user is passwordless and removing their oAuthConnections would leave them with no authentication method!")]
        CannotRemoveLastAuthenticationOption,
 
        [Description("No .dme configured and could not automatically detect one!")]
        DeploymentNoDme,
 
        [Description("Could not load configured .dme!")]
        DeploymentMissingDme,
 
        [Description("Compiler exited with a non-zero exit code!")]
        DeploymentExitCode,
 
        [Description("There is already a deployment operation in progress!")]
        DeploymentInProgress,
 
        [Description("Could not retrieve DreamDaemon settings from the database!")]
        InstanceMissingDreamDaemonSettings,
 
        [Description("Could not retrieve DreamMaker settings from the database!")]
        InstanceMissingDreamMakerSettings,
 
        [Description("Could not retrieve Repository settings from the database!")]
        InstanceMissingRepositorySettings,
 
        [Description("Performing this automatic update as a merge would result in conficts. Aborting!")]
        InstanceUpdateTestMergeConflict,
 
        [Description("Git credentials are required for this operation!")]
        RepoCredentialsRequired,
 
        [Description("The remote is requesting authentication, but is not allowing credentials to be received!")]
        RepoCannotAuthenticate,
 
        [Description("This git operation requires the repository HEAD to currently be on a tracked reference!")]
        RepoReferenceRequired,
 
        [Description("The watchdog is already running!")]
        WatchdogRunning,
 
        [Description("Cannot launch active compile job as it is missing or corrupted!")]
        WatchdogCompileJobCorrupted,
 
        [Description("Game server failed to start!")]
        WatchdogStartupFailed,
 
        [Description("Game server failed to start within the configured timeout!")]
        WatchdogStartupTimeout,
 
        [Description("Test merging with the current remote is not supported!")]
        RepoUnsupportedTestMergeRemote,
 
        [Description("The value set for checkoutSha or reference should be in the other field!")]
        RepoSwappedShaOrReference,
 
        [Description("A merge conflict occurred while performing the operation!")]
        RepoMergeConflict,
 
        [Description("The repository's current reference is unsuitable for this operation as it does not track a remote reference!")]
        RepoReferenceNotTracking,
 
        [Description("Encountered merge conflicts while test merging one or more sources!")]
        RepoTestMergeConflict,
 
        [Description("The new instance's path is not under a white-listed path.")]
        InstanceNotAtWhitelistedPath,
 
        [Description("Cannot set both softShutdown and softReboot at once!")]
        GameServerDoubleSoft,
 
        [Description("Cannot start DreamDaemon headless with the BYOND pager running!")]
        DreamDaemonPagerRunning,
 
        [Description("Could not bind to requested game server port! Is there another service running on that port?")]
        GameServerPortInUse,
 
        [Description("The deployment succeeded but one or more notification events failed!")]
        PostDeployFailure,
 
        [Description("Cannot restart the watchdog as it is not running!")]
        WatchdogNotRunning,
 
        [Description("The requested resource is not currently present, but may have been in the past.")]
        ResourceNotPresent,
 
        [Description("The requested resource is not present and never has been.")]
        ResourceNeverPresent,
 
        [Description("A required GitHub API call failed due to rate limiting.")]
        GitHubApiRateLimit,
 
        [Description("Cannot cancel the job as it is no longer running.")]
        JobStopped,
 
        [Description("Attempted to create a process dump but /usr/bin/gcore could not be located!")]
        MissingGCore,
 
        [Description("Could not create dump as gcore exited with a non-zero exit code!")]
        GCoreFailure,
 
        [Description("Test merging cannot be performed with this remote!")]
        RepoTestMergeInvalidRemote,
 
        [Description("Cannot switch to requested custom engine version as it is not currently installed.")]
        EngineNonExistentCustomVersion,
 
        [Description("Cannot perform this operation as the game server is not currently running!")]
        GameServerOffline,
 
        [Description("The instance associated with the operation is currently offline!")]
        InstanceOffline,
 
        [Description("Failed to connect chat bot!")]
        ChatCannotConnectProvider,
 
        [Description("Failed to allow game server through the Windows firewall!")]
        EngineFirewallFail,
 
        [Description("TGS was unable to find a free port to allocate for the operation!")]
        NoPortsAvailable,
 
        [Description("The requested port is either already in use by TGS or could not be allocated!")]
        PortNotAvailable,
 
        [Description("The admin user cannot use OAuth connections!")]
        AdminUserCannotOAuth,
 
        [Description("The requested OAuth provider is disabled via configuration!")]
        OAuthProviderDisabled,
 
        [Description("The job did not receive a required upload before timing out!")]
        FileUploadExpired,
 
        [Description("A user may not have both a permissionSet and group!")]
        UserGroupAndPermissionSet,
 
        [Description("Cannot delete the user group as it is not empty!")]
        UserGroupNotEmpty,
 
        [Description("The user cannot be created because the configured limit has been reached!")]
        UserLimitReached,
 
        [Description("The user group cannot be created because the configured limit has been reached!")]
        UserGroupLimitReached,
 
        [Description("The deployment took longer than the configured timeout!")]
        DeploymentTimeout,
 
        [Description("Could not send broadcast to the DMAPI. This can happen either due to there being an insufficient DMAPI version, a communication failure, or the server being offline.")]
        BroadcastFailure,
 
        [Description("OpenDream could not be compiled due to being unable to locate the dotnet executable!")]
        OpenDreamCantFindDotnet,
 
        [Description("The specified OpenDream version is too old!")]
        OpenDreamTooOld,
 
        [Description("Could not create dump as dotnet diagnostics threw an exception!")]
        DotnetDiagnosticsFailure,
 
        [Description("Could not load configured .dme due to it being outside the deployment directory! This should be a relative path.")]
        DeploymentWrongDme,
 
        [Description("Provided repository username doesn't match the user of the corresponding access token!")]
        RepoTokenUsernameMismatch,
 
        [Description("GraphQL swarm remote gateways not implemented!")]
        RemoteGatewaysNotImplemented,
    }

FieldPresence

enum Tgstation.Server.Api.Models.FieldPresence

Indicates whether a request field is Required or Ignored.

Enumerator
Optional	The field is optional.
Required	The field is required.
Ignored	The field is ignored or should not appear.

Definition at line 6 of file FieldPresence.cs.

    {
        Optional,
 
        Required,
 
        Ignored,
    }

IrcPasswordType

enum Tgstation.Server.Api.Models.IrcPasswordType

Represents the type of a password for a ChatProvider.Irc.

Enumerator
Server	Use server authentication.
Sasl	Use PLAIN sasl authentication.
NickServ	Use NickServ authentication.
Oper	Use OPER authentication.

Definition at line 6 of file IrcPasswordType.cs.

    {
        Server,
 
        Sasl,
 
        NickServ,
 
        Oper,
    }

JobCode

enum Tgstation.Server.Api.Models.JobCode : byte

The different types of Response.JobResponse.

Enumerator
Unknown	This catch-all code is applied to jobs that were created on a tgstation-server before v5.17.0.
Move	When the instance is being moved.
RepositoryClone	When the repository is cloning.
RepositoryUpdate	When the repository is being manually updated.
RepositoryAutoUpdate	When the repository is being automatically updated.
RepositoryDelete	When the repository is being deleted.
EngineOfficialInstall	When a new official engine version is being installed.
EngineCustomInstall	When a new custom engine version is being installed.
EngineDelete	When an installed engine version is being deleted.
Deployment	When a deployment is manually triggered.
AutomaticDeployment	When a deployment is automatically triggered.
WatchdogLaunch	When the watchdog is started manually.
WatchdogRestart	When the watchdog is restarted manually.
WatchdogDump	When a the watchdog is dumping the game server process.
StartupWatchdogLaunch	When the watchdog starts due to an instance being onlined.
StartupWatchdogReattach	When the watchdog reattaches due to an instance being onlined.
ReconnectChatBot	When a chat bot connects/reconnects.
RepositoryReclone	When a repository is recloned.

Definition at line 8 of file JobCode.cs.

    {
        [Description("Legacy job")]
        Unknown,
 
        [Description("Move instance")]
        Move,
 
        [Description("Clone repository")]
        RepositoryClone,
 
        [Description("Update repository")]
        RepositoryUpdate,
 
        [Description("Scheduled repository update")]
        RepositoryAutoUpdate,
 
        [Description("Delete repository")]
        RepositoryDelete,
 
        [Description("Install engine version")]
        EngineOfficialInstall,
 
        [Description("Install custom engine version")]
        EngineCustomInstall,
 
        [Description("Delete installed engine version")]
        EngineDelete,
 
        [Description("Compile active repository code")]
        Deployment,
 
        [Description("Scheduled code deployment")]
        AutomaticDeployment,
 
        [Description("Launch Watchdog")]
        WatchdogLaunch,
 
        [Description("Restart Watchdog")]
        WatchdogRestart,
 
        [Description("Create DreamDaemon Process Dump")]
        WatchdogDump,
 
        [Description("Instance startup watchdog launch")]
        StartupWatchdogLaunch,
 
        [Description("Instance startup watchdog reattach")]
        StartupWatchdogReattach,
 
        [Description("Reconnect chat bot")]
        ReconnectChatBot,
 
        [Description("Reclone repository")]
        RepositoryReclone,
    }

OAuthProvider

enum Tgstation.Server.Api.Models.OAuthProvider

List of OAuth providers supported by TGS.

Enumerator
GitHub	https://github.com.
Discord	https://discord.com.
TGForums	https://tgstation13.org.
Keycloak	https://www.keycloak.org.
InvisionCommunity	https://invisioncommunity.com.

Definition at line 10 of file OAuthProvider.cs.

    {
        GitHub,
 
        Discord,
 
        TGForums,
 
        Keycloak,
 
        InvisionCommunity,
    }

RemoteGitProvider

enum Tgstation.Server.Api.Models.RemoteGitProvider

Indicates the remote git host.

Enumerator
Unknown	Unknown remote git provider.
GitHub	Remote provider is GitHub.com.
GitLab	Remote provider is GitLab.com.

Definition at line 6 of file RemoteGitProvider.cs.

    {
        Unknown,
 
        GitHub,
 
        GitLab,
    }

WatchdogStatus

enum Tgstation.Server.Api.Models.WatchdogStatus

The current status of the watchdog.

Enumerator
Offline	The watchdog is not running.
Restoring	The watchdog is online and attempting to bring DreamDaemon back to operational status.
Online	The watchdog is online and DreamDaemon is running.
DelayedRestart	The watchdog is online and in a delayed sleep to bring DreamDaemon back.

Definition at line 6 of file WatchdogStatus.cs.

    {
        Offline,
 
        Restoring,
 
        Online,
 
        DelayedRestart,
    }