ErrorCode.cs

Go to the documentation of this file.

using System.ComponentModel;
 
using Tgstation.Server.Common;
 
namespace Tgstation.Server.Api.Models
{
    public enum ErrorCode : uint
    {
        [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,
    }
}