From 84af4870e8cc6a79f7ccaaddb6e014846e77b895 Mon Sep 17 00:00:00 2001 From: "tgstation-server-ci[bot]" <161980869+tgstation-server-ci[bot]@users.noreply.github.com> Date: Sat, 8 Feb 2025 17:07:43 +0000 Subject: [PATCH] Deploy code docs to GitHub Pages for workflow run 3615 Commit: 2ff53c37d24c8781dfbe9bb1f25e38b127745b86 --- _administration_client_8cs_source.html | 4 +- _administration_response_8cs_source.html | 8 +- _advanced_watchdog_8cs_source.html | 6 +- _api_controller_8cs_source.html | 2 +- _api_exception_8cs_source.html | 6 +- _api_headers_8cs_source.html | 2 +- _api_root_controller_8cs_source.html | 10 +- _application_8cs_source.html | 6 +- ...ication_builder_extensions_8cs_source.html | 2 +- ...entication_context_factory_8cs_source.html | 2 +- _basic_watchdog_8cs_source.html | 4 +- _byond_installation_8cs_source.html | 12 +- _byond_installer_base_8cs_source.html | 2 +- _chat_bot_8cs_source.html | 12 +- _chat_bot_api_base_8cs_source.html | 2 +- _chat_bot_settings_8cs_source.html | 88 +- _chat_bots_client_8cs_source.html | 2 +- _chat_channel_base_8cs_source.html | 44 +- _chat_controller_8cs_source.html | 6 +- _configuration_client_8cs_source.html | 2 +- _database_seeder_8cs_source.html | 2 +- _deployment_lock_manager_8cs_source.html | 2 +- _discord_provider_8cs_source.html | 6 +- _dmb_factory_8cs_source.html | 8 +- _dmb_provider_8cs_source.html | 2 +- _dmb_provider_base_8cs_source.html | 2 +- _dream_daemon_api_base_8cs_source.html | 42 +- _dream_daemon_client_8cs_source.html | 2 +- _dream_daemon_controller_8cs_source.html | 2 +- ...m_daemon_launch_parameters_8cs_source.html | 172 +-- _dream_daemon_response_8cs_source.html | 62 +- _dream_maker_8cs_source.html | 6 +- _dream_maker_client_8cs_source.html | 2 +- _dream_maker_controller_8cs_source.html | 2 +- _engine_client_8cs_source.html | 2 +- _engine_command_8cs_source.html | 4 +- _engine_controller_8cs_source.html | 2 +- _engine_installation_base_8cs_source.html | 2 +- _engine_manager_8cs_source.html | 8 +- _engine_version_8cs_source.html | 312 ++--- _entity_id_8cs_source.html | 12 +- _error_message_exception_8cs_source.html | 2 +- _error_message_response_8cs_source.html | 60 +- _general_configuration_8cs_source.html | 8 +- _git_hub_remote_features_8cs_source.html | 6 +- _git_lab_remote_features_8cs_source.html | 8 +- _git_remote_features_base_8cs_source.html | 2 +- _instance_client_8cs_source.html | 2 +- _instance_controller_8cs_source.html | 8 +- _instance_manager_8cs_source.html | 2 +- _instance_manager_client_8cs_source.html | 2 +- ...ance_permission_set_client_8cs_source.html | 2 +- ..._permission_set_controller_8cs_source.html | 2 +- _irc_provider_8cs_source.html | 2 +- _job_controller_8cs_source.html | 2 +- _job_response_8cs_source.html | 38 +- _job_service_8cs_source.html | 12 +- _jobs_client_8cs_source.html | 2 +- _jobs_hub_group_mapper_8cs_source.html | 2 +- _log_file_response_8cs_source.html | 14 +- _login_authority_8cs_source.html | 4 +- _my_sql_database_context_8cs_source.html | 4 +- _paginated_client_8cs_source.html | 2 +- _paginated_response_8cs_source.html | 20 +- _port_allocator_8cs_source.html | 2 +- _posix_byond_installer_8cs_source.html | 2 +- _posix_watchdog_8cs_source.html | 2 +- _repository_8cs_source.html | 6 +- _repository_client_8cs_source.html | 2 +- _repository_controller_8cs_source.html | 2 +- _repository_update_service_8cs_source.html | 2 +- _rest_server_client_factory_8cs_source.html | 2 +- _root_controller_8cs_source.html | 4 +- _server_information_base_8cs_source.html | 34 +- _server_information_response_8cs_source.html | 46 +- _server_update_request_8cs_source.html | 16 +- _server_update_response_8cs_source.html | 26 +- _session_controller_8cs_source.html | 2 +- _session_controller_factory_8cs_source.html | 18 +- _swagger_configuration_8cs_source.html | 1032 +++++++++-------- _swarm_node_8cs_source.html | 4 +- _swarm_server_8cs_source.html | 50 +- _swarm_server_information_8cs_source.html | 36 +- _swarm_service_8cs_source.html | 2 +- _test_merge_api_base_8cs_source.html | 16 +- _test_merge_model_base_8cs_source.html | 86 +- _test_merge_parameters_8cs_source.html | 29 +- ...pi_2_models_2_chat_channel_8cs_source.html | 12 +- ...s_2_internal_2_compile_job_8cs_source.html | 44 +- ..._2_models_2_internal_2_job_8cs_source.html | 64 +- ...ernal_2_update_information_8cs_source.html | 14 +- ...ls_2_internal_2_user_group_8cs_source.html | 2 +- ...pi_2_models_2_named_entity_8cs_source.html | 14 +- ..._2_models_2_permission_set_8cs_source.html | 2 +- ...8_api_2_models_2_user_name_8cs_source.html | 46 +- ...st_2_models_2_chat_channel_8cs_source.html | 10 +- ...ost_2_models_2_compile_job_8cs_source.html | 10 +- ...8_host_2_models_2_instance_8cs_source.html | 4 +- ...rver_8_host_2_models_2_job_8cs_source.html | 18 +- ...host_2_models_2_test_merge_8cs_source.html | 18 +- ...host_2_models_2_user_group_8cs_source.html | 4 +- _token_response_8cs_source.html | 12 +- _user_authority_8cs_source.html | 2 +- _user_controller_8cs_source.html | 2 +- _user_mutations_8cs_source.html | 2 +- _watchdog_base_8cs_source.html | 6 +- _windows_byond_installer_8cs_source.html | 2 +- changelog.yml | 9 +- ...on_1_1_server_1_1_api_1_1_api_headers.html | 16 +- ...r_1_1_api_1_1_models_1_1_chat_channel.html | 5 +- ...1_1_api_1_1_models_1_1_engine_version.html | 288 ++--- ...rver_1_1_api_1_1_models_1_1_entity_id.html | 7 +- ...ls_1_1_internal_1_1_chat_bot_api_base.html | 4 +- ...ls_1_1_internal_1_1_chat_bot_settings.html | 60 +- ...ls_1_1_internal_1_1_chat_channel_base.html | 24 +- ...al_1_1_chat_connection_string_builder.html | 2 +- ...1_models_1_1_internal_1_1_compile_job.html | 22 +- ..._1_internal_1_1_dream_daemon_api_base.html | 23 +- ...al_1_1_dream_daemon_launch_parameters.html | 138 +-- ...1_api_1_1_models_1_1_internal_1_1_job.html | 34 +- ..._internal_1_1_server_information_base.html | 25 +- ..._models_1_1_internal_1_1_swarm_server.html | 43 +- ...internal_1_1_swarm_server_information.html | 25 +- ..._1_1_internal_1_1_test_merge_api_base.html | 9 +- ..._1_internal_1_1_test_merge_model_base.html | 75 +- ...s_1_1_internal_1_1_update_information.html | 9 +- ..._server_1_1_api_1_1_models_1_1_limits.html | 2 +- ...r_1_1_api_1_1_models_1_1_named_entity.html | 5 +- ...1_1_request_1_1_server_update_request.html | 9 +- ..._response_1_1_administration_response.html | 5 +- ..._1_response_1_1_dream_daemon_response.html | 35 +- ...1_response_1_1_error_message_response.html | 53 +- ...1_1_response_1_1_file_ticket_response.html | 2 +- ..._models_1_1_response_1_1_job_response.html | 27 +- ...ls_1_1_response_1_1_log_file_response.html | 9 +- ...s_1_1_response_1_1_paginated_response.html | 15 +- ...ponse_1_1_server_information_response.html | 32 +- ...1_response_1_1_server_update_response.html | 21 +- ...odels_1_1_response_1_1_token_response.html | 5 +- ...models_1_1_response_options_attribute.html | 2 +- ..._1_1_models_1_1_test_merge_parameters.html | 21 +- ...rver_1_1_api_1_1_models_1_1_user_name.html | 33 +- ..._1_1_client_1_1_administration_client.html | 6 +- ...1_server_1_1_client_1_1_api_exception.html | 2 +- ...1_components_1_1_configuration_client.html | 6 +- ...ient_1_1_components_1_1_engine_client.html | 4 +- ...nt_1_1_components_1_1_instance_client.html | 4 +- ..._1_client_1_1_instance_manager_client.html | 4 +- ...erver_1_1_client_1_1_paginated_client.html | 4 +- ...client_1_1_rest_server_client_factory.html | 4 +- ...ost_1_1_authority_1_1_login_authority.html | 6 +- ...host_1_1_authority_1_1_user_authority.html | 4 +- ..._chat_1_1_commands_1_1_engine_command.html | 6 +- ...1_chat_1_1_providers_1_1_irc_provider.html | 4 +- ...eployment_1_1_deployment_lock_manager.html | 6 +- ...onents_1_1_deployment_1_1_dmb_factory.html | 12 +- ...onents_1_1_deployment_1_1_dream_maker.html | 8 +- ...nts_1_1_engine_1_1_byond_installation.html | 6 +- ...s_1_1_engine_1_1_byond_installer_base.html | 6 +- ...1_engine_1_1_engine_installation_base.html | 4 +- ...ponents_1_1_engine_1_1_engine_manager.html | 20 +- ..._1_engine_1_1_open_dream_installation.html | 4 +- ..._1_1_engine_1_1_posix_byond_installer.html | 4 +- ..._1_engine_1_1_windows_byond_installer.html | 6 +- ...t_1_1_components_1_1_instance_manager.html | 4 +- ...epository_1_1_git_hub_remote_features.html | 8 +- ...epository_1_1_git_lab_remote_features.html | 8 +- ...pository_1_1_git_remote_features_base.html | 4 +- ...ponents_1_1_repository_1_1_repository.html | 8 +- ...ts_1_1_session_1_1_session_controller.html | 8 +- ...ession_1_1_session_controller_factory.html | 22 +- ...ts_1_1_watchdog_1_1_advanced_watchdog.html | 12 +- ...nents_1_1_watchdog_1_1_basic_watchdog.html | 10 +- ...onents_1_1_watchdog_1_1_watchdog_base.html | 14 +- ...nfiguration_1_1_general_configuration.html | 10 +- ...st_1_1_controllers_1_1_api_controller.html | 4 +- ...1_controllers_1_1_api_root_controller.html | 14 +- ...t_1_1_controllers_1_1_chat_controller.html | 14 +- ...ntrollers_1_1_dream_daemon_controller.html | 6 +- ...ontrollers_1_1_dream_maker_controller.html | 6 +- ...1_1_controllers_1_1_engine_controller.html | 4 +- ...1_controllers_1_1_instance_controller.html | 22 +- ..._1_instance_permission_set_controller.html | 8 +- ...st_1_1_controllers_1_1_job_controller.html | 6 +- ...controllers_1_1_repository_controller.html | 12 +- ...t_1_1_controllers_1_1_root_controller.html | 6 +- ..._1_1_controllers_1_1_swarm_controller.html | 2 +- ...1_controllers_1_1_transfer_controller.html | 4 +- ...t_1_1_controllers_1_1_user_controller.html | 4 +- ...ver_1_1_host_1_1_core_1_1_application.html | 10 +- ...host_1_1_database_1_1_database_seeder.html | 4 +- ..._database_1_1_my_sql_database_context.html | 6 +- ...ns_1_1_application_builder_extensions.html | 4 +- ...graph_q_l_1_1_error_message_exception.html | 4 +- ..._q_l_1_1_mutations_1_1_user_mutations.html | 4 +- ..._1_graph_q_l_1_1_types_1_1_swarm_node.html | 2 +- ...ver_1_1_host_1_1_jobs_1_1_job_service.html | 22 +- ...st_1_1_jobs_1_1_jobs_hub_group_mapper.html | 4 +- ...rver_1_1_host_1_1_models_1_1_chat_bot.html | 2 +- ..._1_1_host_1_1_models_1_1_chat_channel.html | 2 +- ...r_1_1_host_1_1_models_1_1_compile_job.html | 2 +- ...rver_1_1_host_1_1_models_1_1_instance.html | 2 +- ..._1_server_1_1_host_1_1_models_1_1_job.html | 14 +- ...er_1_1_host_1_1_models_1_1_test_merge.html | 2 +- ...er_1_1_host_1_1_models_1_1_user_group.html | 2 +- ...ty_1_1_authentication_context_factory.html | 4 +- ..._1_1_host_1_1_swarm_1_1_swarm_service.html | 18 +- ...1_1_open_api_enum_var_names_extension.html | 2 +- ...1_1_host_1_1_utils_1_1_port_allocator.html | 4 +- ...t_1_1_utils_1_1_swagger_configuration.html | 955 +++++++-------- ...r_1_1_host_1_1_jobs_1_1_i_job_manager.html | 4 +- ...r_1_1_host_1_1_jobs_1_1_i_job_service.html | 2 +- 212 files changed, 2714 insertions(+), 2596 deletions(-) diff --git a/_administration_client_8cs_source.html b/_administration_client_8cs_source.html index 9ca05b01b0..72aef325fe 100644 --- a/_administration_client_8cs_source.html +++ b/_administration_client_8cs_source.html @@ -163,10 +163,10 @@ $(document).ready(function() { init_codefold(0); });
81}
Stream
Tgstation.Server.Api.Models.Request.ServerUpdateRequest
Represents a request to update TGS.
Definition ServerUpdateRequest.cs:9
-
Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip
bool? UploadZip
If the user will provide the server update package .zip file via file transfer as opposed to TGS retr...
Definition ServerUpdateRequest.cs:19
+
Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip
bool? UploadZip
If the user will provide the server update package .zip file via file transfer as opposed to TGS retr...
Definition ServerUpdateRequest.cs:20
Tgstation.Server.Api.Models.Response.AdministrationResponse
Represents administrative server information.
Definition AdministrationResponse.cs:11
Tgstation.Server.Api.Models.Response.LogFileResponse
Represents a server log file.
Definition LogFileResponse.cs:9
-
Tgstation.Server.Api.Models.Response.LogFileResponse.Name
string? Name
The name of the log file.
Definition LogFileResponse.cs:13
+
Tgstation.Server.Api.Models.Response.LogFileResponse.Name
string? Name
The name of the log file.
Definition LogFileResponse.cs:14
Tgstation.Server.Api.Models.Response.ServerUpdateResponse
A response to a Request.ServerUpdateRequest.
Definition ServerUpdateResponse.cs:11
Tgstation.Server.Api.Routes
Routes to a server actions.
Definition Routes.cs:9
Tgstation.Server.Api.Routes.Administration
const string Administration
The server administration controller.
Definition Routes.cs:28
diff --git a/_administration_response_8cs_source.html b/_administration_response_8cs_source.html index 88c5883b7a..7223aa3c4c 100644 --- a/_administration_response_8cs_source.html +++ b/_administration_response_8cs_source.html @@ -92,14 +92,14 @@ $(document).ready(function() { init_codefold(0); });
10 public sealed class AdministrationResponse : UpdateInformation
11 {
-
15 public Uri? TrackedRepositoryUrl { get; set; }
-
16 }
+
16 public Uri? TrackedRepositoryUrl { get; set; }
+
17 }
-
17}
+
18}
Tgstation.Server.Api.Models.Internal.UpdateInformation
Indicates data from the TGS update source.
Definition UpdateInformation.cs:9
Tgstation.Server.Api.Models.Response.AdministrationResponse
Represents administrative server information.
Definition AdministrationResponse.cs:11
-
Tgstation.Server.Api.Models.Response.AdministrationResponse.TrackedRepositoryUrl
Uri? TrackedRepositoryUrl
The GitHub repository the server is built to receive updates from.
Definition AdministrationResponse.cs:15
+
Tgstation.Server.Api.Models.Response.AdministrationResponse.TrackedRepositoryUrl
Uri? TrackedRepositoryUrl
The GitHub repository the server is built to receive updates from.
Definition AdministrationResponse.cs:16
Tgstation.Server.Api.Models.Internal
Definition ChatBotApiBase.cs:6
Tgstation.Server.Api.Models.Response
Definition AdministrationResponse.cs:6
diff --git a/_advanced_watchdog_8cs_source.html b/_advanced_watchdog_8cs_source.html index 2d382300c6..953bb91475 100644 --- a/_advanced_watchdog_8cs_source.html +++ b/_advanced_watchdog_8cs_source.html @@ -479,10 +479,10 @@ $(document).ready(function() { init_codefold(0); });
Exception
IAsyncDisposable
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
Tgstation.Server.Api.Models.Internal.CompileJob.DmeName
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:16
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
Tgstation.Server.Api.Models.Internal.CompileJob.DmeName
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:17
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters
Launch settings for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:10
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:62
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:68
Tgstation.Server.Host.Components.Deployment.DmbFactory
Standard IDmbFactory.
Definition DmbFactory.cs:29
Tgstation.Server.Host.Components.Deployment.DmbFactory.LockNextDmb
IDmbProvider LockNextDmb(string reason, [CallerFilePath] string? callerFile=null, [CallerLineNumber] int callerLine=default)
Gets the next IDmbProvider. DmbAvailable is a precondition.A new IDmbProvider.
Definition DmbFactory.cs:195
Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider
A IDmbProvider that uses filesystem links to change directory structure underneath the server process...
Definition SwappableDmbProvider.cs:14
diff --git a/_api_controller_8cs_source.html b/_api_controller_8cs_source.html index 0ae3954248..2e1271139d 100644 --- a/_api_controller_8cs_source.html +++ b/_api_controller_8cs_source.html @@ -374,7 +374,7 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.ApiHeaders.InstanceId
long? InstanceId
The instance EntityId.Id being accessed.
Definition ApiHeaders.cs:84
Tgstation.Server.Api.HeadersException
Thrown when trying to generate ApiHeaders from Microsoft.AspNetCore.Http.Headers.RequestHeaders fails...
Definition HeadersException.cs:9
Tgstation.Server.Api.HeadersException.ParseErrors
HeaderErrorTypes ParseErrors
The HeaderErrorTypess that are missing or malformed.
Definition HeadersException.cs:13
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
Tgstation.Server.Api.Models.Response.PaginatedResponse
Represents a paginated set of models.
Definition PaginatedResponse.cs:11
diff --git a/_api_exception_8cs_source.html b/_api_exception_8cs_source.html index 61135701de..9fa27fda4c 100644 --- a/_api_exception_8cs_source.html +++ b/_api_exception_8cs_source.html @@ -142,9 +142,9 @@ $(document).ready(function() { init_codefold(0); });
80}
Exception
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
-
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ServerApiVersion
Version? ServerApiVersion
The version of the API the server is using.
Definition ErrorMessageResponse.cs:16
-
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.AdditionalData
string? AdditionalData
Additional data associated with the error message.
Definition ErrorMessageResponse.cs:27
-
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorCode
ErrorCode ErrorCode
The ErrorCode of the ErrorMessageResponse.
Definition ErrorMessageResponse.cs:34
+
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ServerApiVersion
Version? ServerApiVersion
The version of the API the server is using.
Definition ErrorMessageResponse.cs:17
+
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.AdditionalData
string? AdditionalData
Additional data associated with the error message.
Definition ErrorMessageResponse.cs:30
+
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorCode
ErrorCode ErrorCode
The ErrorCode of the ErrorMessageResponse.
Definition ErrorMessageResponse.cs:37
Tgstation.Server.Client.ApiException
API related Exceptions.
Definition ApiException.cs:13
Tgstation.Server.Client.ApiException.AdditionalServerData
string? AdditionalServerData
Additional error data from the server.
Definition ApiException.cs:22
Tgstation.Server.Client.ApiException.ApiException
ApiException(HttpResponseMessage responseMessage, string message)
Initializes a new instance of the ApiException class.
Definition ApiException.cs:49
diff --git a/_api_headers_8cs_source.html b/_api_headers_8cs_source.html index 09dbc052f1..41fbdb9238 100644 --- a/_api_headers_8cs_source.html +++ b/_api_headers_8cs_source.html @@ -432,7 +432,7 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.ApiHeaders.Password
string? Password
The client's password.
Definition ApiHeaders.cs:114
Tgstation.Server.Api.HeadersException
Thrown when trying to generate ApiHeaders from Microsoft.AspNetCore.Http.Headers.RequestHeaders fails...
Definition HeadersException.cs:9
Tgstation.Server.Api.Models.Response.TokenResponse
Represents a JWT returned by the API.
Definition TokenResponse.cs:9
-
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:13
+
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:14
Tgstation.Server.Api.Models.Response.TokenResponse.ParseJwt
JsonWebToken ParseJwt()
Parses the Bearer as a JsonWebToken.
Tgstation.Server.Api.Properties.ApiVersionAttribute
Attribute for bringing in the HTTP API version from MSBuild.
Definition ApiVersionAttribute.cs:11
Tgstation.Server.Api.Properties.ApiVersionAttribute.Instance
static ApiVersionAttribute Instance
Return the Assembly's instance of the ApiVersionAttribute.
Definition ApiVersionAttribute.cs:15
diff --git a/_api_root_controller_8cs_source.html b/_api_root_controller_8cs_source.html index 870a1a62fd..45107e3014 100644 --- a/_api_root_controller_8cs_source.html +++ b/_api_root_controller_8cs_source.html @@ -237,11 +237,11 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.ApiHeaders
Represents the header that must be present for every server request.
Definition ApiHeaders.cs:25
Tgstation.Server.Api.ApiHeaders.Version
static readonly Version Version
Get the version of the Api the caller is using.
Definition ApiHeaders.cs:69
Tgstation.Server.Api.HeadersException
Thrown when trying to generate ApiHeaders from Microsoft.AspNetCore.Http.Headers.RequestHeaders fails...
Definition HeadersException.cs:9
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit
uint UserGroupLimit
The maximum number of user groups allowed.
Definition ServerInformationBase.cs:28
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
Definition ServerInformationBase.cs:34
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength
uint MinimumPasswordLength
Minimum length of database user passwords.
Definition ServerInformationBase.cs:13
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit
uint UserLimit
The maximum number of users allowed.
Definition ServerInformationBase.cs:23
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit
uint InstanceLimit
The maximum number of Instances allowed.
Definition ServerInformationBase.cs:18
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit
uint UserGroupLimit
The maximum number of user groups allowed.
Definition ServerInformationBase.cs:32
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
Definition ServerInformationBase.cs:39
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength
uint MinimumPasswordLength
Minimum length of database user passwords.
Definition ServerInformationBase.cs:14
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit
uint UserLimit
The maximum number of users allowed.
Definition ServerInformationBase.cs:26
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit
uint InstanceLimit
The maximum number of Instances allowed.
Definition ServerInformationBase.cs:20
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
Tgstation.Server.Api.Models.Response.OAuthGatewayResponse
Success result for an OAuth gateway login attempt.
Definition OAuthGatewayResponse.cs:7
Tgstation.Server.Api.Models.Response.ServerInformationResponse
Represents basic server information.
Definition ServerInformationResponse.cs:10
diff --git a/_application_8cs_source.html b/_application_8cs_source.html index 7d9207f369..7933f6c738 100644 --- a/_application_8cs_source.html +++ b/_application_8cs_source.html @@ -943,9 +943,9 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Host.Utils.PortAllocator
Definition PortAllocator.cs:21
Tgstation.Server.Host.Utils.SerilogContextHelper
Helpers for manipulating the Serilog.Context.LogContext.
Definition SerilogContextHelper.cs:7
Tgstation.Server.Host.Utils.SerilogContextHelper.Template
static string Template
Common template used for adding our custom log context to serilog.
Definition SerilogContextHelper.cs:62
-
Tgstation.Server.Host.Utils.SwaggerConfiguration
Implements various filters for Swashbuckle.
Definition SwaggerConfiguration.cs:29
-
Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
Definition SwaggerConfiguration.cs:38
-
Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure
static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)
Configure the swagger settings.
Definition SwaggerConfiguration.cs:61
+
Tgstation.Server.Host.Utils.SwaggerConfiguration
Implements various filters for Swashbuckle.
Definition SwaggerConfiguration.cs:30
+
Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
Definition SwaggerConfiguration.cs:39
+
Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure
static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)
Configure the swagger settings.
Definition SwaggerConfiguration.cs:62
Tgstation.Server.Shared.VersionConverter
JsonConverter and IYamlTypeConverter for serializing global::System.Versions in semver format.
Definition VersionConverter.cs:17
Tgstation.Server.Api.Hubs.IJobsHub
SignalR client methods for receiving JobResponses.
Definition IJobsHub.cs:12
Tgstation.Server.Common.Http.IAbstractHttpClientFactory
Creates IHttpClients.
Definition IAbstractHttpClientFactory.cs:7
diff --git a/_application_builder_extensions_8cs_source.html b/_application_builder_extensions_8cs_source.html index 5a464392b4..b8943bdf93 100644 --- a/_application_builder_extensions_8cs_source.html +++ b/_application_builder_extensions_8cs_source.html @@ -269,7 +269,7 @@ $(document).ready(function() { init_codefold(0); });
210}
Exception
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
Tgstation.Server.Host.Configuration.SwarmConfiguration
Configuration for the server swarm system.
Definition SwarmConfiguration.cs:13
Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions
Extensions for IApplicationBuilder.
Definition ApplicationBuilderExtensions.cs:27
diff --git a/_authentication_context_factory_8cs_source.html b/_authentication_context_factory_8cs_source.html index 088dec8192..1dce04d432 100644 --- a/_authentication_context_factory_8cs_source.html +++ b/_authentication_context_factory_8cs_source.html @@ -263,7 +263,7 @@ $(document).ready(function() { init_codefold(0); });
IDisposable
Tgstation.Server.Api.ApiHeaders
Represents the header that must be present for every server request.
Definition ApiHeaders.cs:25
Tgstation.Server.Api.ApiHeaders.InstanceId
long? InstanceId
The instance EntityId.Id being accessed.
Definition ApiHeaders.cs:84
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Host.Configuration.SwarmConfiguration
Configuration for the server swarm system.
Definition SwarmConfiguration.cs:13
Tgstation.Server.Host.Models.InstancePermissionSet
Definition InstancePermissionSet.cs:9
Tgstation.Server.Host.Models.PermissionSet
Definition PermissionSet.cs:9
diff --git a/_basic_watchdog_8cs_source.html b/_basic_watchdog_8cs_source.html index ba32fe7dd5..4bb272d94e 100644 --- a/_basic_watchdog_8cs_source.html +++ b/_basic_watchdog_8cs_source.html @@ -376,9 +376,9 @@ $(document).ready(function() { init_codefold(0); });
333}
Exception
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Internal.CompileJob
Represents a deployment run.
Definition CompileJob.cs:11
-
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:41
+
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:43
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters
Launch settings for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:10
Tgstation.Server.Host.Components.Deployment.DmbFactory
Standard IDmbFactory.
Definition DmbFactory.cs:29
Tgstation.Server.Host.Components.Deployment.DmbFactory.LockNextDmb
IDmbProvider LockNextDmb(string reason, [CallerFilePath] string? callerFile=null, [CallerLineNumber] int callerLine=default)
Gets the next IDmbProvider. DmbAvailable is a precondition.A new IDmbProvider.
Definition DmbFactory.cs:195
diff --git a/_byond_installation_8cs_source.html b/_byond_installation_8cs_source.html index e7b1305b49..d481e75484 100644 --- a/_byond_installation_8cs_source.html +++ b/_byond_installation_8cs_source.html @@ -223,12 +223,12 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters
Launch settings for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:10
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
Definition DreamDaemonLaunchParameters.cs:47
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:31
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AllowWebClient
bool? AllowWebClient
If the BYOND web client can be used to connect to the game server. No-op for EngineType....
Definition DreamDaemonLaunchParameters.cs:16
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartProfiler
bool? StartProfiler
If -profile is passed in on the DreamDaemon command line. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:23
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:39
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.MapThreads
uint? MapThreads
If DreamDaemon supports it, the value added as the -map-threads parameter. 0 uses the default BYOND v...
Definition DreamDaemonLaunchParameters.cs:106
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
Definition DreamDaemonLaunchParameters.cs:51
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:33
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AllowWebClient
bool? AllowWebClient
If the BYOND web client can be used to connect to the game server. No-op for EngineType....
Definition DreamDaemonLaunchParameters.cs:17
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartProfiler
bool? StartProfiler
If -profile is passed in on the DreamDaemon command line. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:24
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:42
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.MapThreads
uint? MapThreads
If DreamDaemon supports it, the value added as the -map-threads parameter. 0 uses the default BYOND v...
Definition DreamDaemonLaunchParameters.cs:114
Tgstation.Server.Host.Components.Engine.ByondInstallation
Implementation of IEngineInstallation for EngineType.Byond.
Definition ByondInstallation.cs:17
Tgstation.Server.Host.Components.Engine.ByondInstallation.supportsMapThreads
readonly bool supportsMapThreads
If map threads are supported by the Version.
Definition ByondInstallation.cs:45
Tgstation.Server.Host.Components.Engine.ByondInstallation.PromptsForNetworkAccess
override bool PromptsForNetworkAccess
If ServerExePath may create network prompts.
Definition ByondInstallation.cs:28
diff --git a/_byond_installer_base_8cs_source.html b/_byond_installer_base_8cs_source.html index 5ed2a4df51..b3dd51b830 100644 --- a/_byond_installer_base_8cs_source.html +++ b/_byond_installer_base_8cs_source.html @@ -245,7 +245,7 @@ $(document).ready(function() { init_codefold(0); });
202}
Exception
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:30
+
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:31
Tgstation.Server.Host.Components.Engine.ByondInstallation
Implementation of IEngineInstallation for EngineType.Byond.
Definition ByondInstallation.cs:17
Tgstation.Server.Host.Components.Engine.ByondInstallerBase
Base implementation of IEngineInstaller for EngineType.Byond.
Definition ByondInstallerBase.cs:20
Tgstation.Server.Host.Components.Engine.ByondInstallerBase.fileDownloader
readonly IFileDownloader fileDownloader
The IFileDownloader for the ByondInstallerBase.
Definition ByondInstallerBase.cs:62
diff --git a/_chat_bot_8cs_source.html b/_chat_bot_8cs_source.html index 566e66c2fe..3186e484fe 100644 --- a/_chat_bot_8cs_source.html +++ b/_chat_bot_8cs_source.html @@ -135,13 +135,13 @@ $(document).ready(function() { init_codefold(0); });
64}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ChannelLimit
ushort? ChannelLimit
The maximum number of ChatChannels the ChatBotSettings may contain.
Definition ChatBotSettings.cs:27
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ChannelLimit
ushort? ChannelLimit
The maximum number of ChatChannels the ChatBotSettings may contain.
Definition ChatBotSettings.cs:29
Tgstation.Server.Api.Models.Internal.ChatBotSettings.Enabled
bool? Enabled
If the connection is enabled.
Definition ChatBotSettings.cs:14
-
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString
string? ConnectionString
The information used to connect to the Provider.
Definition ChatBotSettings.cs:44
-
Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider
ChatProvider? Provider
The ChatProvider used for the connection.
Definition ChatBotSettings.cs:35
-
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ReconnectionInterval
uint? ReconnectionInterval
The time interval in minutes the chat bot attempts to reconnect if Enabled and disconnected....
Definition ChatBotSettings.cs:21
-
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:16
+
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString
string? ConnectionString
The information used to connect to the Provider.
Definition ChatBotSettings.cs:46
+
Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider
ChatProvider? Provider
The ChatProvider used for the connection.
Definition ChatBotSettings.cs:37
+
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ReconnectionInterval
uint? ReconnectionInterval
The time interval in minutes the chat bot attempts to reconnect if Enabled and disconnected....
Definition ChatBotSettings.cs:22
+
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:17
Tgstation.Server.Api.Models.Response.ChatBotResponse
Represents a chat bot response.
Definition ChatBotResponse.cs:9
Tgstation.Server.Host.Models.ChatBot
Definition ChatBot.cs:12
Tgstation.Server.Host.Models.ChatBot.Channels
ICollection< ChatChannel > Channels
See Api.Models.Internal.ChatBotApiBase.Channels.
Definition ChatBot.cs:32
diff --git a/_chat_bot_api_base_8cs_source.html b/_chat_bot_api_base_8cs_source.html index d3a3014437..e3412c99c6 100644 --- a/_chat_bot_api_base_8cs_source.html +++ b/_chat_bot_api_base_8cs_source.html @@ -115,7 +115,7 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.Models.Internal.ChatBotApiBase.ValidateProviderChannelTypes
bool ValidateProviderChannelTypes()
Validates Channels are correct for the ChatBotSettings.Provider.
Definition ChatBotApiBase.cs:19
Tgstation.Server.Api.Models.Internal.ChatBotApiBase.Channels
ICollection< ChatChannel >? Channels
Channels the Discord bot should listen/announce in.
Definition ChatBotApiBase.cs:13
Tgstation.Server.Api.Models.Internal.ChatBotSettings
Manage the server chat bots.
Definition ChatBotSettings.cs:10
-
Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider
ChatProvider? Provider
The ChatProvider used for the connection.
Definition ChatBotSettings.cs:35
+
Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider
ChatProvider? Provider
The ChatProvider used for the connection.
Definition ChatBotSettings.cs:37
Tgstation.Server.Api.Models.Internal
Definition ChatBotApiBase.cs:6
diff --git a/_chat_bot_settings_8cs_source.html b/_chat_bot_settings_8cs_source.html index 8faaf88400..611473f3b6 100644 --- a/_chat_bot_settings_8cs_source.html +++ b/_chat_bot_settings_8cs_source.html @@ -92,56 +92,56 @@ $(document).ready(function() { init_codefold(0); });
10 {
14 public bool? Enabled { get; set; }
15
-
19 [Required]
-
20 [Range(1, UInt32.MaxValue)]
-
21 public uint? ReconnectionInterval { get; set; }
-
22
-
26 [Required]
-
27 public ushort? ChannelLimit { get; set; }
-
28
-
32 [Required]
-
33 [RequestOptions(FieldPresence.Required, PutOnly = true)]
-
34 [EnumDataType(typeof(ChatProvider))]
-
35 public ChatProvider? Provider { get; set; }
-
36
-
40 [Required]
-
41 [RequestOptions(FieldPresence.Required, PutOnly = true)]
-
42 [ResponseOptions]
-
43 [StringLength(Limits.MaximumStringLength)]
-
44 public string? ConnectionString { get; set; }
-
45
-
-
50 public ChatConnectionStringBuilder? CreateConnectionStringBuilder()
-
51 {
-
52 if (ConnectionString == null)
-
53 return null;
-
54 return Provider switch
-
55 {
-
56 ChatProvider.Discord => new DiscordConnectionStringBuilder(ConnectionString),
-
57 ChatProvider.Irc => new IrcConnectionStringBuilder(ConnectionString),
-
58 _ => throw new InvalidOperationException("Invalid Provider!"),
-
59 };
-
60 }
+
20 [Required]
+
21 [Range(1, UInt32.MaxValue)]
+
22 public uint? ReconnectionInterval { get; set; }
+
23
+
28 [Required]
+
29 public ushort? ChannelLimit { get; set; }
+
30
+
34 [Required]
+
35 [RequestOptions(FieldPresence.Required, PutOnly = true)]
+
36 [EnumDataType(typeof(ChatProvider))]
+
37 public ChatProvider? Provider { get; set; }
+
38
+
42 [Required]
+
43 [RequestOptions(FieldPresence.Required, PutOnly = true)]
+
44 [ResponseOptions]
+
45 [StringLength(Limits.MaximumStringLength)]
+
46 public string? ConnectionString { get; set; }
+
47
+
+ +
53 {
+
54 if (ConnectionString == null)
+
55 return null;
+
56 return Provider switch
+
57 {
+
58 ChatProvider.Discord => new DiscordConnectionStringBuilder(ConnectionString),
+
59 ChatProvider.Irc => new IrcConnectionStringBuilder(ConnectionString),
+
60 _ => throw new InvalidOperationException("Invalid Provider!"),
+
61 };
+
62 }
-
61
-
- -
67 {
-
68 ConnectionString = stringBuilder?.ToString() ?? throw new ArgumentNullException(nameof(stringBuilder));
-
69 }
+
63
+
+ +
69 {
+
70 ConnectionString = stringBuilder?.ToString() ?? throw new ArgumentNullException(nameof(stringBuilder));
+
71 }
-
70 }
+
72 }
-
71}
+
73}
ChatConnectionStringBuilder for ChatProvider.Discord.
Manage the server chat bots.
-
ushort? ChannelLimit
The maximum number of ChatChannels the ChatBotSettings may contain.
+
ushort? ChannelLimit
The maximum number of ChatChannels the ChatBotSettings may contain.
bool? Enabled
If the connection is enabled.
-
string? ConnectionString
The information used to connect to the Provider.
-
ChatProvider? Provider
The ChatProvider used for the connection.
-
uint? ReconnectionInterval
The time interval in minutes the chat bot attempts to reconnect if Enabled and disconnected....
-
void SetConnectionStringBuilder(ChatConnectionStringBuilder stringBuilder)
Set the ChatConnectionStringBuilder for the ChatBotSettings. Also updates the ConnectionString.
-
ChatConnectionStringBuilder? CreateConnectionStringBuilder()
Get the ChatConnectionStringBuilder which maps to the ConnectionString.
+
string? ConnectionString
The information used to connect to the Provider.
+
ChatProvider? Provider
The ChatProvider used for the connection.
+
uint? ReconnectionInterval
The time interval in minutes the chat bot attempts to reconnect if Enabled and disconnected....
+
void SetConnectionStringBuilder(ChatConnectionStringBuilder stringBuilder)
Set the ChatConnectionStringBuilder for the ChatBotSettings. Also updates the ConnectionString.
+
ChatConnectionStringBuilder? CreateConnectionStringBuilder()
Get the ChatConnectionStringBuilder which maps to the ConnectionString.
Helper for building ChatBotSettings.ConnectionStrings.
override string ToString()
Gets the ChatBotSettings.ConnectionString associated with the ChatConnectionStringBuilder.
ChatConnectionStringBuilder for ChatProvider.Irc.
diff --git a/_chat_bots_client_8cs_source.html b/_chat_bots_client_8cs_source.html index 2b5778c8f6..bd8156b65a 100644 --- a/_chat_bots_client_8cs_source.html +++ b/_chat_bots_client_8cs_source.html @@ -123,7 +123,7 @@ $(document).ready(function() { init_codefold(0); });
48}
Tgstation.Server.Api.Models.EntityId
Common base of entities with IDs.
Definition EntityId.cs:7
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Request.ChatBotCreateRequest
Represents a request to update a chat bot.
Definition ChatBotCreateRequest.cs:9
Tgstation.Server.Api.Models.Request.ChatBotUpdateRequest
Represents a request to update a chat bot.
Definition ChatBotUpdateRequest.cs:9
diff --git a/_chat_channel_base_8cs_source.html b/_chat_channel_base_8cs_source.html index 86f3e42234..3dffb6d123 100644 --- a/_chat_channel_base_8cs_source.html +++ b/_chat_channel_base_8cs_source.html @@ -89,30 +89,30 @@ $(document).ready(function() { init_codefold(0); });
8 public abstract class ChatChannelBase
9 {
-
13 [Required]
-
14 public bool? IsAdminChannel { get; set; }
-
15
-
19 [Required]
-
20 public bool? IsWatchdogChannel { get; set; }
-
21
-
25 [Required]
-
26 public bool? IsUpdatesChannel { get; set; }
-
27
-
31 [Required]
-
32 public bool? IsSystemChannel { get; set; }
-
33
-
37 [ResponseOptions]
-
38 [StringLength(Limits.MaximumStringLength)]
-
39 public string? Tag { get; set; }
-
40 }
+
14 [Required]
+
15 public bool? IsAdminChannel { get; set; }
+
16
+
21 [Required]
+
22 public bool? IsWatchdogChannel { get; set; }
+
23
+
28 [Required]
+
29 public bool? IsUpdatesChannel { get; set; }
+
30
+
34 [Required]
+
35 public bool? IsSystemChannel { get; set; }
+
36
+
41 [ResponseOptions]
+
42 [StringLength(Limits.MaximumStringLength)]
+
43 public string? Tag { get; set; }
+
44 }
-
41}
+
45}
Tgstation.Server.Api.Models.Internal.ChatChannelBase
Base chat channel class.
Definition ChatChannelBase.cs:9
-
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsUpdatesChannel
bool? IsUpdatesChannel
If the ChatChannel is an updates channel.
Definition ChatChannelBase.cs:26
-
Tgstation.Server.Api.Models.Internal.ChatChannelBase.Tag
string? Tag
A custom tag users can define to group channels together.
Definition ChatChannelBase.cs:39
-
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsSystemChannel
bool? IsSystemChannel
If the ChatChannel received system messages.
Definition ChatChannelBase.cs:32
-
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsWatchdogChannel
bool? IsWatchdogChannel
If the ChatChannel is a watchdog channel.
Definition ChatChannelBase.cs:20
-
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsAdminChannel
bool? IsAdminChannel
If the ChatChannel is an admin channel.
Definition ChatChannelBase.cs:14
+
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsUpdatesChannel
bool? IsUpdatesChannel
If the ChatChannel is an updates channel.
Definition ChatChannelBase.cs:29
+
Tgstation.Server.Api.Models.Internal.ChatChannelBase.Tag
string? Tag
A custom tag users can define to group channels together.
Definition ChatChannelBase.cs:43
+
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsSystemChannel
bool? IsSystemChannel
If the ChatChannel received system messages.
Definition ChatChannelBase.cs:35
+
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsWatchdogChannel
bool? IsWatchdogChannel
If the ChatChannel is a watchdog channel.
Definition ChatChannelBase.cs:22
+
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsAdminChannel
bool? IsAdminChannel
If the ChatChannel is an admin channel.
Definition ChatChannelBase.cs:15
Tgstation.Server.Api.Models.Limits
Sanity limits to prevent users from overloading.
Definition Limits.cs:9
Tgstation.Server.Api.Models.Limits.MaximumStringLength
const int MaximumStringLength
Length limit for strings in fields.
Definition Limits.cs:13
Tgstation.Server.Api.Models.Internal
Definition ChatBotApiBase.cs:6
diff --git a/_chat_controller_8cs_source.html b/_chat_controller_8cs_source.html index 6ae1b69cdd..5c2b4b4c7a 100644 --- a/_chat_controller_8cs_source.html +++ b/_chat_controller_8cs_source.html @@ -448,12 +448,12 @@ $(document).ready(function() { init_codefold(0); });
411#pragma warning restore CA1506
412}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Instance.ChatBotLimit
ushort? ChatBotLimit
The maximum number of chat bots the Instance may contain.
Definition Instance.cs:50
Tgstation.Server.Api.Models.Internal.ChatBotApiBase
Definition ChatBotApiBase.cs:9
-
Tgstation.Server.Api.Models.Internal.ChatChannelBase.Tag
string? Tag
A custom tag users can define to group channels together.
Definition ChatChannelBase.cs:39
-
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:16
+
Tgstation.Server.Api.Models.Internal.ChatChannelBase.Tag
string? Tag
A custom tag users can define to group channels together.
Definition ChatChannelBase.cs:43
+
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:17
Tgstation.Server.Api.Models.Request.ChatBotCreateRequest
Represents a request to update a chat bot.
Definition ChatBotCreateRequest.cs:9
Tgstation.Server.Api.Models.Request.ChatBotUpdateRequest
Represents a request to update a chat bot.
Definition ChatBotUpdateRequest.cs:9
Tgstation.Server.Api.Models.Response.ChatBotResponse
Represents a chat bot response.
Definition ChatBotResponse.cs:9
diff --git a/_configuration_client_8cs_source.html b/_configuration_client_8cs_source.html index 3b85f00b5e..977d1c9368 100644 --- a/_configuration_client_8cs_source.html +++ b/_configuration_client_8cs_source.html @@ -180,7 +180,7 @@ $(document).ready(function() { init_codefold(0); });
103}
Stream
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Request.ConfigurationFileRequest
Represents a request to update a configuration file.
Definition ConfigurationFileRequest.cs:7
Tgstation.Server.Api.Models.Response.ConfigurationFileResponse
Response when reading configuration files.
Definition ConfigurationFileResponse.cs:7
diff --git a/_database_seeder_8cs_source.html b/_database_seeder_8cs_source.html index a8f257a776..526f93da47 100644 --- a/_database_seeder_8cs_source.html +++ b/_database_seeder_8cs_source.html @@ -362,7 +362,7 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.DefaultCredentials
Represents initial credentials used by the server.
Definition DefaultCredentials.cs:7
Tgstation.Server.Api.DefaultCredentials.DefaultAdminUserPassword
static readonly string DefaultAdminUserPassword
The default admin password.
Definition DefaultCredentials.cs:16
Tgstation.Server.Api.DefaultCredentials.AdminUserName
static readonly string AdminUserName
The name of the default admin user.
Definition DefaultCredentials.cs:11
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Api.Rights.RightsHelper
Helper for RightsTypes.
Definition RightsHelper.cs:12
Tgstation.Server.Host.Configuration.DatabaseConfiguration
Configuration options for the Database.DatabaseContext.
Definition DatabaseConfiguration.cs:10
Tgstation.Server.Host.Configuration.DatabaseConfiguration.DropDatabase
bool DropDatabase
If the database should be deleted on application startup. Should not be used in production!...
Definition DatabaseConfiguration.cs:35
diff --git a/_deployment_lock_manager_8cs_source.html b/_deployment_lock_manager_8cs_source.html index b930ee50a3..d18c1453ad 100644 --- a/_deployment_lock_manager_8cs_source.html +++ b/_deployment_lock_manager_8cs_source.html @@ -201,7 +201,7 @@ $(document).ready(function() { init_codefold(0); });
166}
IAsyncDisposable
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Host.Components.Deployment.DeploymentLockManager
Manages locks on a given IDmbProvider.
Definition DeploymentLockManager.cs:18
Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.firstLock
readonly DmbLock firstLock
The first lock acquired by the DeploymentLockManager.
Definition DeploymentLockManager.cs:42
Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.GetFullLockDescriptor
static string GetFullLockDescriptor(DmbLock dmbLock)
Generates a verbose description of a given dmbLock .
diff --git a/_discord_provider_8cs_source.html b/_discord_provider_8cs_source.html index db35b25559..6f80962373 100644 --- a/_discord_provider_8cs_source.html +++ b/_discord_provider_8cs_source.html @@ -1142,9 +1142,9 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.Models.DiscordConnectionStringBuilder
ChatConnectionStringBuilder for ChatProvider.Discord.
Definition DiscordConnectionStringBuilder.cs:12
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
-
Tgstation.Server.Api.Models.EngineVersion.CustomIteration
int? CustomIteration
The revision of the custom build.
Definition EngineVersion.cs:43
-
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString
string? ConnectionString
The information used to connect to the Provider.
Definition ChatBotSettings.cs:44
-
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsAdminChannel
bool? IsAdminChannel
If the ChatChannel is an admin channel.
Definition ChatChannelBase.cs:14
+
Tgstation.Server.Api.Models.EngineVersion.CustomIteration
int? CustomIteration
The revision of the custom build.
Definition EngineVersion.cs:45
+
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString
string? ConnectionString
The information used to connect to the Provider.
Definition ChatBotSettings.cs:46
+
Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsAdminChannel
bool? IsAdminChannel
If the ChatChannel is an admin channel.
Definition ChatChannelBase.cs:15
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
diff --git a/_dmb_factory_8cs_source.html b/_dmb_factory_8cs_source.html index 6e042c9b8a..137e5c58b9 100644 --- a/_dmb_factory_8cs_source.html +++ b/_dmb_factory_8cs_source.html @@ -572,11 +572,11 @@ $(document).ready(function() { init_codefold(0); });
546}
Exception
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EngineVersion.TryParse
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
Definition EngineVersion.cs:51
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EngineVersion.TryParse
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
Definition EngineVersion.cs:53
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
-
Tgstation.Server.Api.Models.Internal.CompileJob.DirectoryName
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:28
-
Tgstation.Server.Api.Models.Internal.Job.StoppedAt
DateTimeOffset? StoppedAt
When the Job stopped.
Definition Job.cs:48
+
Tgstation.Server.Api.Models.Internal.CompileJob.DirectoryName
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:29
+
Tgstation.Server.Api.Models.Internal.Job.StoppedAt
DateTimeOffset? StoppedAt
When the Job stopped.
Definition Job.cs:49
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
Tgstation.Server.Host.Components.Deployment.DeploymentLockManager
Manages locks on a given IDmbProvider.
Definition DeploymentLockManager.cs:18
diff --git a/_dmb_provider_8cs_source.html b/_dmb_provider_8cs_source.html index 3c82a7bb4d..4b1f0e88fc 100644 --- a/_dmb_provider_8cs_source.html +++ b/_dmb_provider_8cs_source.html @@ -132,7 +132,7 @@ $(document).ready(function() { init_codefold(0); });
65}
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
Tgstation.Server.Api.Models.Internal.CompileJob
Represents a deployment run.
Definition CompileJob.cs:11
-
Tgstation.Server.Api.Models.Internal.CompileJob.DirectoryName
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:28
+
Tgstation.Server.Api.Models.Internal.CompileJob.DirectoryName
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:29
Tgstation.Server.Host.Components.Deployment.DmbProviderBase
Definition DmbProviderBase.cs:12
Tgstation.Server.Host.Components.Deployment.DmbProvider
Definition DmbProvider.cs:13
Tgstation.Server.Host.Components.Deployment.DmbProvider.ioManager
readonly IIOManager ioManager
The IIOManager for the DmbProvider.
Definition DmbProvider.cs:26
diff --git a/_dmb_provider_base_8cs_source.html b/_dmb_provider_base_8cs_source.html index 74e9bfbfb7..5e45bd7111 100644 --- a/_dmb_provider_base_8cs_source.html +++ b/_dmb_provider_base_8cs_source.html @@ -118,7 +118,7 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
Tgstation.Server.Api.Models.Internal.CompileJob
Represents a deployment run.
Definition CompileJob.cs:11
-
Tgstation.Server.Api.Models.Internal.CompileJob.DmeName
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:16
+
Tgstation.Server.Api.Models.Internal.CompileJob.DmeName
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:17
Tgstation.Server.Host.Components.Deployment.DmbProviderBase
Definition DmbProviderBase.cs:12
Tgstation.Server.Host.Components.Deployment.DmbProviderBase.KeepAlive
void KeepAlive()
Disposing the IDmbProvider won't cause a cleanup of the working directory.
Tgstation.Server.Host.Components.Deployment.DmbProviderBase.DmbName
string DmbName
The file name of the .dmb.
Definition DmbProviderBase.cs:14
diff --git a/_dream_daemon_api_base_8cs_source.html b/_dream_daemon_api_base_8cs_source.html index dff0c79ffa..cc400e2b0a 100644 --- a/_dream_daemon_api_base_8cs_source.html +++ b/_dream_daemon_api_base_8cs_source.html @@ -89,29 +89,29 @@ $(document).ready(function() { init_codefold(0); });
8 public abstract class DreamDaemonApiBase : DreamDaemonSettings
9 {
-
13 [ResponseOptions]
-
14 public long? SessionId { get; set; }
-
15
-
19 [ResponseOptions]
-
20 public DateTimeOffset? LaunchTime { get; set; }
-
21
-
25 [ResponseOptions]
-
26 public uint? ClientCount { get; set; }
-
27
-
31 [ResponseOptions]
-
32 public bool? SoftRestart { get; set; }
-
33
-
37 [ResponseOptions]
-
38 public bool? SoftShutdown { get; set; }
-
39 }
+
14 [ResponseOptions]
+
15 public long? SessionId { get; set; }
+
16
+
20 [ResponseOptions]
+
21 public DateTimeOffset? LaunchTime { get; set; }
+
22
+
27 [ResponseOptions]
+
28 public uint? ClientCount { get; set; }
+
29
+
34 [ResponseOptions]
+
35 public bool? SoftRestart { get; set; }
+
36
+
40 [ResponseOptions]
+
41 public bool? SoftShutdown { get; set; }
+
42 }
-
40}
+
43}
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase
Base class for DreamDaemon API models.
Definition DreamDaemonApiBase.cs:9
-
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SoftShutdown
bool? SoftShutdown
If the server is undergoing a soft shutdown.
Definition DreamDaemonApiBase.cs:38
-
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SoftRestart
bool? SoftRestart
If the server is undergoing a soft reset. This may be automatically set by changes to other fields.
Definition DreamDaemonApiBase.cs:32
-
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.LaunchTime
DateTimeOffset? LaunchTime
When the current server execution was started.
Definition DreamDaemonApiBase.cs:20
-
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SessionId
long? SessionId
An incrementing ID for representing current server execution.
Definition DreamDaemonApiBase.cs:14
-
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.ClientCount
uint? ClientCount
The last known count of connected players. Requires DreamDaemonLaunchParameters.HealthCheckSeconds to...
Definition DreamDaemonApiBase.cs:26
+
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SoftShutdown
bool? SoftShutdown
If the server is undergoing a soft shutdown.
Definition DreamDaemonApiBase.cs:41
+
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SoftRestart
bool? SoftRestart
If the server is undergoing a soft reset. This may be automatically set by changes to other fields.
Definition DreamDaemonApiBase.cs:35
+
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.LaunchTime
DateTimeOffset? LaunchTime
When the current server execution was started.
Definition DreamDaemonApiBase.cs:21
+
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.SessionId
long? SessionId
An incrementing ID for representing current server execution.
Definition DreamDaemonApiBase.cs:15
+
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase.ClientCount
uint? ClientCount
The last known count of connected players. Requires DreamDaemonLaunchParameters.HealthCheckSeconds to...
Definition DreamDaemonApiBase.cs:28
Tgstation.Server.Api.Models.Internal.DreamDaemonSettings
Configurable settings for DreamDaemon.
Definition DreamDaemonSettings.cs:9
Tgstation.Server.Api.Models.Internal
Definition ChatBotApiBase.cs:6
diff --git a/_dream_daemon_client_8cs_source.html b/_dream_daemon_client_8cs_source.html index 779044a38b..7c795f8698 100644 --- a/_dream_daemon_client_8cs_source.html +++ b/_dream_daemon_client_8cs_source.html @@ -125,7 +125,7 @@ $(document).ready(function() { init_codefold(0); });
56 }
57}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Request.DreamDaemonRequest
A request to update DreamDaemonSettings.
Definition DreamDaemonRequest.cs:9
Tgstation.Server.Api.Models.Response.DreamDaemonResponse
Represents an instance of BYOND's DreamDaemon game server. Create action starts the server....
Definition DreamDaemonResponse.cs:11
diff --git a/_dream_daemon_controller_8cs_source.html b/_dream_daemon_controller_8cs_source.html index a4cf261871..ff51319a1a 100644 --- a/_dream_daemon_controller_8cs_source.html +++ b/_dream_daemon_controller_8cs_source.html @@ -431,7 +431,7 @@ $(document).ready(function() { init_codefold(0); });
407 }
408}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.InstancePermissionSet.DreamDaemonRights
DreamDaemonRights? DreamDaemonRights
The Rights.DreamDaemonRights of the InstancePermissionSet.
Definition InstancePermissionSet.cs:36
Tgstation.Server.Api.Models.Request.DreamDaemonRequest
A request to update DreamDaemonSettings.
Definition DreamDaemonRequest.cs:9
diff --git a/_dream_daemon_launch_parameters_8cs_source.html b/_dream_daemon_launch_parameters_8cs_source.html index ef35bbbf15..c74eebf290 100644 --- a/_dream_daemon_launch_parameters_8cs_source.html +++ b/_dream_daemon_launch_parameters_8cs_source.html @@ -90,105 +90,105 @@ $(document).ready(function() { init_codefold(0); });
9 public class DreamDaemonLaunchParameters
10 {
-
14 [Required]
-
15 [ResponseOptions]
-
16 public bool? AllowWebClient { get; set; }
-
17
-
21 [Required]
-
22 [ResponseOptions]
-
23 public bool? StartProfiler { get; set; }
-
24
-
28 [Required]
-
29 [ResponseOptions]
-
30 [EnumDataType(typeof(DreamDaemonVisibility))]
-
31 public DreamDaemonVisibility? Visibility { get; set; }
-
32
-
36 [Required]
-
37 [ResponseOptions]
-
38 [EnumDataType(typeof(DreamDaemonSecurity))]
-
39 public DreamDaemonSecurity? SecurityLevel { get; set; }
-
40
-
44 [Required]
-
45 [ResponseOptions]
-
46 [Range(1, UInt16.MaxValue)]
-
47 public ushort? Port { get; set; }
-
48
-
52 [Required]
-
53 [ResponseOptions]
-
54 public ushort? OpenDreamTopicPort { get; set; }
-
55
-
59 [Required]
-
60 [ResponseOptions]
-
61 [Range(1, UInt32.MaxValue)]
-
62 public uint? StartupTimeout { get; set; }
-
63
-
67 [Required]
-
68 [ResponseOptions]
-
69 public uint? HealthCheckSeconds { get; set; }
-
70
+
15 [Required]
+
16 [ResponseOptions]
+
17 public bool? AllowWebClient { get; set; }
+
18
+
22 [Required]
+
23 [ResponseOptions]
+
24 public bool? StartProfiler { get; set; }
+
25
+
30 [Required]
+
31 [ResponseOptions]
+
32 [EnumDataType(typeof(DreamDaemonVisibility))]
+
33 public DreamDaemonVisibility? Visibility { get; set; }
+
34
+
39 [Required]
+
40 [ResponseOptions]
+
41 [EnumDataType(typeof(DreamDaemonSecurity))]
+
42 public DreamDaemonSecurity? SecurityLevel { get; set; }
+
43
+
48 [Required]
+
49 [ResponseOptions]
+
50 [Range(1, UInt16.MaxValue)]
+
51 public ushort? Port { get; set; }
+
52
+
57 [Required]
+
58 [ResponseOptions]
+
59 public ushort? OpenDreamTopicPort { get; set; }
+
60
+
65 [Required]
+
66 [ResponseOptions]
+
67 [Range(1, UInt32.MaxValue)]
+
68 public uint? StartupTimeout { get; set; }
+
69
74 [Required]
75 [ResponseOptions]
-
76 public bool? DumpOnHealthCheckRestart { get; set; }
+
76 public uint? HealthCheckSeconds { get; set; }
77
81 [Required]
82 [ResponseOptions]
-
83 [Range(1, UInt32.MaxValue)]
-
84 public uint? TopicRequestTimeout { get; set; }
-
85
+
83 public bool? DumpOnHealthCheckRestart { get; set; }
+
84
89 [Required]
90 [ResponseOptions]
-
91 [StringLength(Limits.MaximumStringLength)]
-
92 public string? AdditionalParameters { get; set; }
+
91 [Range(1, UInt32.MaxValue)]
+
92 public uint? TopicRequestTimeout { get; set; }
93
97 [Required]
98 [ResponseOptions]
-
99 public bool? LogOutput { get; set; }
-
100
-
104 [Required]
-
105 [ResponseOptions]
-
106 public uint? MapThreads { get; set; }
-
107
-
111 [Required]
-
112 [ResponseOptions]
-
113 public bool? Minidumps { get; set; }
-
114
-
-
121 public bool CanApplyWithoutReboot(DreamDaemonLaunchParameters otherParameters, EngineType engineType)
-
122 {
-
123 if (otherParameters == null)
-
124 throw new ArgumentNullException(nameof(otherParameters));
-
125
-
126 return AllowWebClient == otherParameters.AllowWebClient
-
127 && SecurityLevel == otherParameters.SecurityLevel
-
128 && Visibility == otherParameters.Visibility
-
129 && Port == otherParameters.Port
-
130 && (OpenDreamTopicPort == otherParameters.OpenDreamTopicPort || engineType != EngineType.OpenDream)
-
131 && TopicRequestTimeout == otherParameters.TopicRequestTimeout
-
132 && AdditionalParameters == otherParameters.AdditionalParameters
-
133 && StartProfiler == otherParameters.StartProfiler
-
134 && LogOutput == otherParameters.LogOutput
-
135 && MapThreads == otherParameters.MapThreads; // We intentionally don't check StartupTimeout, Minidumps, health check seconds, or health check dump as they don't matter in terms of the watchdog
-
136 }
+
99 [StringLength(Limits.MaximumStringLength)]
+
100 public string? AdditionalParameters { get; set; }
+
101
+
105 [Required]
+
106 [ResponseOptions]
+
107 public bool? LogOutput { get; set; }
+
108
+
112 [Required]
+
113 [ResponseOptions]
+
114 public uint? MapThreads { get; set; }
+
115
+
119 [Required]
+
120 [ResponseOptions]
+
121 public bool? Minidumps { get; set; }
+
122
+
+
129 public bool CanApplyWithoutReboot(DreamDaemonLaunchParameters otherParameters, EngineType engineType)
+
130 {
+
131 if (otherParameters == null)
+
132 throw new ArgumentNullException(nameof(otherParameters));
+
133
+
134 return AllowWebClient == otherParameters.AllowWebClient
+
135 && SecurityLevel == otherParameters.SecurityLevel
+
136 && Visibility == otherParameters.Visibility
+
137 && Port == otherParameters.Port
+
138 && (OpenDreamTopicPort == otherParameters.OpenDreamTopicPort || engineType != EngineType.OpenDream)
+
139 && TopicRequestTimeout == otherParameters.TopicRequestTimeout
+
140 && AdditionalParameters == otherParameters.AdditionalParameters
+
141 && StartProfiler == otherParameters.StartProfiler
+
142 && LogOutput == otherParameters.LogOutput
+
143 && MapThreads == otherParameters.MapThreads; // We intentionally don't check StartupTimeout, Minidumps, health check seconds, or health check dump as they don't matter in terms of the watchdog
+
144 }
-
137 }
+
145 }
-
138}
+
146}
Launch settings for DreamDaemon.
-
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
-
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
-
bool CanApplyWithoutReboot(DreamDaemonLaunchParameters otherParameters, EngineType engineType)
Check if we match a given set of otherParameters . StartupTimeout is excluded.
-
ushort? OpenDreamTopicPort
The port used by EngineType.OpenDream for its topic port.
-
bool? LogOutput
If process output/error text should be logged.
-
uint? TopicRequestTimeout
The timeout for sending and receiving BYOND topics in milliseconds.
-
bool? AllowWebClient
If the BYOND web client can be used to connect to the game server. No-op for EngineType....
-
uint? HealthCheckSeconds
The number of seconds between each watchdog health check. 0 disables.
-
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
-
bool? StartProfiler
If -profile is passed in on the DreamDaemon command line. No-op for EngineType.OpenDream.
-
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
-
bool? Minidumps
If minidumps should be taken instead of full dumps.
-
string? AdditionalParameters
Parameters string for DreamDaemon.
-
bool? DumpOnHealthCheckRestart
If a process core dump should be created prior to restarting the watchdog due to health check failure...
-
uint? MapThreads
If DreamDaemon supports it, the value added as the -map-threads parameter. 0 uses the default BYOND v...
+
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
+
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
+
bool CanApplyWithoutReboot(DreamDaemonLaunchParameters otherParameters, EngineType engineType)
Check if we match a given set of otherParameters . StartupTimeout is excluded.
+
ushort? OpenDreamTopicPort
The port used by EngineType.OpenDream for its topic port.
+
bool? LogOutput
If process output/error text should be logged.
+
uint? TopicRequestTimeout
The timeout for sending and receiving BYOND topics in milliseconds.
+
bool? AllowWebClient
If the BYOND web client can be used to connect to the game server. No-op for EngineType....
+
uint? HealthCheckSeconds
The number of seconds between each watchdog health check. 0 disables.
+
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
+
bool? StartProfiler
If -profile is passed in on the DreamDaemon command line. No-op for EngineType.OpenDream.
+
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
+
bool? Minidumps
If minidumps should be taken instead of full dumps.
+
string? AdditionalParameters
Parameters string for DreamDaemon.
+
bool? DumpOnHealthCheckRestart
If a process core dump should be created prior to restarting the watchdog due to health check failure...
+
uint? MapThreads
If DreamDaemon supports it, the value added as the -map-threads parameter. 0 uses the default BYOND v...
Sanity limits to prevent users from overloading.
Definition Limits.cs:9
const int MaximumStringLength
Length limit for strings in fields.
Definition Limits.cs:13
diff --git a/_dream_daemon_response_8cs_source.html b/_dream_daemon_response_8cs_source.html index bc2fda5b64..49a1420f32 100644 --- a/_dream_daemon_response_8cs_source.html +++ b/_dream_daemon_response_8cs_source.html @@ -97,44 +97,44 @@ $(document).ready(function() { init_codefold(0); });
21 [ResponseOptions]
22 public CompileJobResponse? StagedCompileJob { get; set; }
23
-
27 [EnumDataType(typeof(WatchdogStatus))]
-
28 [ResponseOptions]
-
29 public WatchdogStatus? Status { get; set; }
-
30
-
34 [EnumDataType(typeof(DreamDaemonSecurity))]
-
35 [ResponseOptions]
-
36 public DreamDaemonSecurity? CurrentSecurity { get; set; }
-
37
-
41 [EnumDataType(typeof(DreamDaemonVisibility))]
-
42 [ResponseOptions]
-
43 public DreamDaemonVisibility? CurrentVisibility { get; set; }
-
44
-
48 [ResponseOptions]
-
49 public ushort? CurrentPort { get; set; }
-
50
-
54 [ResponseOptions]
-
55 public ushort? CurrentTopicPort { get; set; }
-
56
-
60 [ResponseOptions]
-
61 public bool? CurrentAllowWebclient { get; set; }
-
62
+
28 [EnumDataType(typeof(WatchdogStatus))]
+
29 [ResponseOptions]
+
30 public WatchdogStatus? Status { get; set; }
+
31
+
36 [EnumDataType(typeof(DreamDaemonSecurity))]
+
37 [ResponseOptions]
+
38 public DreamDaemonSecurity? CurrentSecurity { get; set; }
+
39
+
44 [EnumDataType(typeof(DreamDaemonVisibility))]
+
45 [ResponseOptions]
+
46 public DreamDaemonVisibility? CurrentVisibility { get; set; }
+
47
+
52 [ResponseOptions]
+
53 public ushort? CurrentPort { get; set; }
+
54
+
59 [ResponseOptions]
+
60 public ushort? CurrentTopicPort { get; set; }
+
61
66 [ResponseOptions]
-
67 public long? ImmediateMemoryUsage { get; set; }
-
68 }
+
67 public bool? CurrentAllowWebclient { get; set; }
+
68
+
73 [ResponseOptions]
+
74 public long? ImmediateMemoryUsage { get; set; }
+
75 }
-
69}
+
76}
Tgstation.Server.Api.Models.Internal.DreamDaemonApiBase
Base class for DreamDaemon API models.
Definition DreamDaemonApiBase.cs:9
Tgstation.Server.Api.Models.Response.CompileJobResponse
Definition CompileJobResponse.cs:9
Tgstation.Server.Api.Models.Response.DreamDaemonResponse
Represents an instance of BYOND's DreamDaemon game server. Create action starts the server....
Definition DreamDaemonResponse.cs:11
-
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.Status
WatchdogStatus? Status
The current WatchdogStatus.
Definition DreamDaemonResponse.cs:29
+
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.Status
WatchdogStatus? Status
The current WatchdogStatus.
Definition DreamDaemonResponse.cs:30
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.ActiveCompileJob
CompileJobResponse? ActiveCompileJob
The live revision.
Definition DreamDaemonResponse.cs:16
-
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentTopicPort
ushort? CurrentTopicPort
The EngineType.OpenDream topic port the running DreamDaemonResponse instance is set to.
Definition DreamDaemonResponse.cs:55
-
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentVisibility
DreamDaemonVisibility? CurrentVisibility
The current DreamDaemonVisibility.
Definition DreamDaemonResponse.cs:43
+
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentTopicPort
ushort? CurrentTopicPort
The EngineType.OpenDream topic port the running DreamDaemonResponse instance is set to.
Definition DreamDaemonResponse.cs:60
+
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentVisibility
DreamDaemonVisibility? CurrentVisibility
The current DreamDaemonVisibility.
Definition DreamDaemonResponse.cs:46
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.StagedCompileJob
CompileJobResponse? StagedCompileJob
The next revision to go live.
Definition DreamDaemonResponse.cs:22
-
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentAllowWebclient
bool? CurrentAllowWebclient
The webclient status the running DreamDaemonResponse instance is set to.
Definition DreamDaemonResponse.cs:61
-
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentPort
ushort? CurrentPort
The port the running DreamDaemonResponse instance is set to.
Definition DreamDaemonResponse.cs:49
-
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.ImmediateMemoryUsage
long? ImmediateMemoryUsage
The amount of RAM in use by the game server in bytes.
Definition DreamDaemonResponse.cs:67
-
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentSecurity
DreamDaemonSecurity? CurrentSecurity
The current DreamDaemonSecurity. May be upgraded. due to requirements of ActiveCompileJob.
Definition DreamDaemonResponse.cs:36
+
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentAllowWebclient
bool? CurrentAllowWebclient
The webclient status the running DreamDaemonResponse instance is set to.
Definition DreamDaemonResponse.cs:67
+
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentPort
ushort? CurrentPort
The port the running DreamDaemonResponse instance is set to.
Definition DreamDaemonResponse.cs:53
+
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.ImmediateMemoryUsage
long? ImmediateMemoryUsage
The amount of RAM in use by the game server in bytes.
Definition DreamDaemonResponse.cs:74
+
Tgstation.Server.Api.Models.Response.DreamDaemonResponse.CurrentSecurity
DreamDaemonSecurity? CurrentSecurity
The current DreamDaemonSecurity. May be upgraded. due to requirements of ActiveCompileJob.
Definition DreamDaemonResponse.cs:38
Tgstation.Server.Api.Models.Internal
Definition ChatBotApiBase.cs:6
Tgstation.Server.Api.Models.Response
Definition AdministrationResponse.cs:6
Tgstation.Server.Api.Models.DreamDaemonVisibility
DreamDaemonVisibility
The visibility setting for DreamDaemon.
Definition DreamDaemonVisibility.cs:7
diff --git a/_dream_maker_8cs_source.html b/_dream_maker_8cs_source.html index ab9d59b866..5b5e3d369c 100644 --- a/_dream_maker_8cs_source.html +++ b/_dream_maker_8cs_source.html @@ -965,11 +965,11 @@ $(document).ready(function() { init_codefold(0); });
1014}
Exception
-
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:177
+
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:179
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters
Launch settings for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:10
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput
bool? LogOutput
If process output/error text should be logged.
Definition DreamDaemonLaunchParameters.cs:99
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:62
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput
bool? LogOutput
If process output/error text should be logged.
Definition DreamDaemonLaunchParameters.cs:107
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:68
Tgstation.Server.Api.Models.Internal.RevisionInformation
Represents information about a current git revison.
Definition RevisionInformation.cs:10
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
diff --git a/_dream_maker_client_8cs_source.html b/_dream_maker_client_8cs_source.html index 6da04df2da..ac7d87d9e1 100644 --- a/_dream_maker_client_8cs_source.html +++ b/_dream_maker_client_8cs_source.html @@ -121,7 +121,7 @@ $(document).ready(function() { init_codefold(0); });
48}
Tgstation.Server.Api.Models.EntityId
Common base of entities with IDs.
Definition EntityId.cs:7
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Request.DreamMakerRequest
A request to the DreamMaker controller.
Definition DreamMakerRequest.cs:9
Tgstation.Server.Api.Models.Response.CompileJobResponse
Definition CompileJobResponse.cs:9
diff --git a/_dream_maker_controller_8cs_source.html b/_dream_maker_controller_8cs_source.html index c6d5550463..309c871aed 100644 --- a/_dream_maker_controller_8cs_source.html +++ b/_dream_maker_controller_8cs_source.html @@ -347,7 +347,7 @@ $(document).ready(function() { init_codefold(0); });
312}
IQueryable
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.InstancePermissionSet.DreamMakerRights
DreamMakerRights? DreamMakerRights
The Rights.DreamMakerRights of the InstancePermissionSet.
Definition InstancePermissionSet.cs:42
Tgstation.Server.Api.Models.Request.DreamMakerRequest
A request to the DreamMaker controller.
Definition DreamMakerRequest.cs:9
diff --git a/_engine_client_8cs_source.html b/_engine_client_8cs_source.html index 1ed23df710..8f4c7d7619 100644 --- a/_engine_client_8cs_source.html +++ b/_engine_client_8cs_source.html @@ -141,7 +141,7 @@ $(document).ready(function() { init_codefold(0); });
65}
Stream
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Request.EngineVersionDeleteRequest
A request to delete a specific EngineVersion.
Definition EngineVersionDeleteRequest.cs:7
Tgstation.Server.Api.Models.Request.EngineVersionRequest
A request to switch to a given EngineVersion.
Definition EngineVersionRequest.cs:7
diff --git a/_engine_command_8cs_source.html b/_engine_command_8cs_source.html index f3f8717b1d..3ac3a1f6d2 100644 --- a/_engine_command_8cs_source.html +++ b/_engine_command_8cs_source.html @@ -167,9 +167,9 @@ $(document).ready(function() { init_codefold(0); });
96}
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EngineVersion.Parse
static EngineVersion Parse(string input)
Parses a stringified EngineVersion.
Definition EngineVersion.cs:124
+
Tgstation.Server.Api.Models.EngineVersion.Parse
static EngineVersion Parse(string input)
Parses a stringified EngineVersion.
Definition EngineVersion.cs:126
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
-
Tgstation.Server.Api.Models.EngineVersion.CustomIteration
int? CustomIteration
The revision of the custom build.
Definition EngineVersion.cs:43
+
Tgstation.Server.Api.Models.EngineVersion.CustomIteration
int? CustomIteration
The revision of the custom build.
Definition EngineVersion.cs:45
Tgstation.Server.Host.Components.Chat.ChatUser
Represents a tgs_chat_user datum.
Definition ChatUser.cs:12
Tgstation.Server.Host.Components.Chat.Commands.EngineCommand
For displaying the installed Byond version.
Definition EngineCommand.cs:17
Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.AdminOnly
bool AdminOnly
If the command should only be available to ChatUsers who's ChatUser.Channel has ChannelRepresentation...
Definition EngineCommand.cs:25
diff --git a/_engine_controller_8cs_source.html b/_engine_controller_8cs_source.html index d35fb69f9d..c3e3da8aef 100644 --- a/_engine_controller_8cs_source.html +++ b/_engine_controller_8cs_source.html @@ -403,7 +403,7 @@ $(document).ready(function() { init_codefold(0); });
370}
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.InstancePermissionSet
Represents a PermissionSets permissions in an Instance.
Definition InstancePermissionSet.cs:13
Tgstation.Server.Api.Models.Internal.InstancePermissionSet.EngineRights
EngineRights? EngineRights
The Rights.EngineRights of the InstancePermissionSet.
Definition InstancePermissionSet.cs:30
diff --git a/_engine_installation_base_8cs_source.html b/_engine_installation_base_8cs_source.html index fb412c22da..b11c883bf1 100644 --- a/_engine_installation_base_8cs_source.html +++ b/_engine_installation_base_8cs_source.html @@ -203,7 +203,7 @@ $(document).ready(function() { init_codefold(0); });
Exception
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters
Launch settings for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:10
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AdditionalParameters
string? AdditionalParameters
Parameters string for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:92
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AdditionalParameters
string? AdditionalParameters
Parameters string for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:100
Tgstation.Server.Host.Components.Engine.EngineInstallationBase
Definition EngineInstallationBase.cs:23
Tgstation.Server.Host.Components.Engine.EngineInstallationBase.EncodeParameters
static string EncodeParameters(IReadOnlyDictionary< string, string > parameters, DreamDaemonLaunchParameters launchParameters)
Encode given parameters for passing as world.params on the command line.
Definition EngineInstallationBase.cs:59
Tgstation.Server.Host.Components.Engine.EngineInstallationBase.PromptsForNetworkAccess
bool PromptsForNetworkAccess
If ServerExePath may create network prompts.
Definition EngineInstallationBase.cs:40
diff --git a/_engine_manager_8cs_source.html b/_engine_manager_8cs_source.html index 097c425a28..e9a8c0f54e 100644 --- a/_engine_manager_8cs_source.html +++ b/_engine_manager_8cs_source.html @@ -682,11 +682,11 @@ $(document).ready(function() { init_codefold(0); });
Exception
Stream
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:177
-
Tgstation.Server.Api.Models.EngineVersion.TryParse
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
Definition EngineVersion.cs:51
-
Tgstation.Server.Api.Models.EngineVersion.Equals
bool Equals(EngineVersion other)
Definition EngineVersion.cs:158
+
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:179
+
Tgstation.Server.Api.Models.EngineVersion.TryParse
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
Definition EngineVersion.cs:53
+
Tgstation.Server.Api.Models.EngineVersion.Equals
bool Equals(EngineVersion other)
Definition EngineVersion.cs:160
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
-
Tgstation.Server.Api.Models.EngineVersion.CustomIteration
int? CustomIteration
The revision of the custom build.
Definition EngineVersion.cs:43
+
Tgstation.Server.Api.Models.EngineVersion.CustomIteration
int? CustomIteration
The revision of the custom build.
Definition EngineVersion.cs:45
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
Tgstation.Server.Host.Components.Engine.EngineExecutableLock
Definition EngineExecutableLock.cs:17
diff --git a/_engine_version_8cs_source.html b/_engine_version_8cs_source.html index fd581c8ff8..5a2e070a8b 100644 --- a/_engine_version_8cs_source.html +++ b/_engine_version_8cs_source.html @@ -99,175 +99,175 @@ $(document).ready(function() { init_codefold(0); });
23 [RequestOptions(FieldPresence.Required)]
24 public EngineType? Engine { get; set; }
25
-
29 [ResponseOptions]
-
30 public Version? Version { get; set; }
-
31
-
35 [ResponseOptions]
-
36 [StringLength(Limits.MaximumCommitShaLength, MinimumLength = Limits.MaximumCommitShaLength)]
-
37 public string? SourceSHA { get; set; }
-
38
-
42 [ResponseOptions]
-
43 public int? CustomIteration { get; set; }
-
44
-
-
51 public static bool TryParse(string input, out EngineVersion? engineVersion)
-
52 {
-
53 if (input == null)
-
54 throw new ArgumentNullException(nameof(input));
-
55
-
56 var splits = input.Split(DashChar, StringSplitOptions.RemoveEmptyEntries);
-
57 engineVersion = null;
-
58
-
59 if (splits.Length > 3)
-
60 return false;
-
61
-
62 EngineType engine;
-
63 var hasPrefix = splits.Length > 1;
-
64 if (hasPrefix)
-
65 {
-
66 if (!Enum.TryParse(splits[0], out engine))
-
67 return false;
-
68 }
-
69 else
-
70 engine = EngineType.Byond;
-
71
-
72 Version? version;
-
73 string? sha;
-
74 int? customRev = null;
-
75 if (engine == EngineType.Byond)
-
76 {
-
77 if (!Version.TryParse(splits.Last(), out version))
-
78 return false;
-
79
-
80 if (version.Build > 0)
-
81 {
-
82 customRev = version.Build;
-
83 version = new Version(version.Major, version.Minor);
-
84 }
-
85
-
86 sha = null;
-
87 }
-
88 else
-
89 {
-
90 Debug.Assert(engine == EngineType.OpenDream, "This does not support whatever ungodly new engine you've added");
-
91
-
92 var shaIndex = hasPrefix ? 1 : 0;
-
93 sha = splits[shaIndex];
-
94 if (sha.Length != Limits.MaximumCommitShaLength)
-
95 return false;
-
96
-
97 version = null;
+
30 [ResponseOptions]
+
31 public Version? Version { get; set; }
+
32
+
37 [ResponseOptions]
+
38 [StringLength(Limits.MaximumCommitShaLength, MinimumLength = Limits.MaximumCommitShaLength)]
+
39 public string? SourceSHA { get; set; }
+
40
+
44 [ResponseOptions]
+
45 public int? CustomIteration { get; set; }
+
46
+
+
53 public static bool TryParse(string input, out EngineVersion? engineVersion)
+
54 {
+
55 if (input == null)
+
56 throw new ArgumentNullException(nameof(input));
+
57
+
58 var splits = input.Split(DashChar, StringSplitOptions.RemoveEmptyEntries);
+
59 engineVersion = null;
+
60
+
61 if (splits.Length > 3)
+
62 return false;
+
63
+
64 EngineType engine;
+
65 var hasPrefix = splits.Length > 1;
+
66 if (hasPrefix)
+
67 {
+
68 if (!Enum.TryParse(splits[0], out engine))
+
69 return false;
+
70 }
+
71 else
+
72 engine = EngineType.Byond;
+
73
+
74 Version? version;
+
75 string? sha;
+
76 int? customRev = null;
+
77 if (engine == EngineType.Byond)
+
78 {
+
79 if (!Version.TryParse(splits.Last(), out version))
+
80 return false;
+
81
+
82 if (version.Build > 0)
+
83 {
+
84 customRev = version.Build;
+
85 version = new Version(version.Major, version.Minor);
+
86 }
+
87
+
88 sha = null;
+
89 }
+
90 else
+
91 {
+
92 Debug.Assert(engine == EngineType.OpenDream, "This does not support whatever ungodly new engine you've added");
+
93
+
94 var shaIndex = hasPrefix ? 1 : 0;
+
95 sha = splits[shaIndex];
+
96 if (sha.Length != Limits.MaximumCommitShaLength)
+
97 return false;
98
-
99 if (splits.Length - 1 > shaIndex)
-
100 {
-
101 if (!Int32.TryParse(splits.Last(), out var customRevResult))
-
102 return false;
-
103
-
104 customRev = customRevResult;
-
105 }
-
106 }
-
107
-
108 engineVersion = new EngineVersion
-
109 {
-
110 Engine = engine,
-
111 Version = version,
-
112 SourceSHA = sha,
-
113 CustomIteration = customRev,
-
114 };
-
115 return true;
-
116 }
+
99 version = null;
+
100
+
101 if (splits.Length - 1 > shaIndex)
+
102 {
+
103 if (!Int32.TryParse(splits.Last(), out var customRevResult))
+
104 return false;
+
105
+
106 customRev = customRevResult;
+
107 }
+
108 }
+
109
+
110 engineVersion = new EngineVersion
+
111 {
+
112 Engine = engine,
+
113 Version = version,
+
114 SourceSHA = sha,
+
115 CustomIteration = customRev,
+
116 };
+
117 return true;
+
118 }
-
117
-
-
124 public static EngineVersion Parse(string input)
-
125 {
-
126 if (input == null)
-
127 throw new ArgumentNullException(nameof(input));
-
128
-
129 if (TryParse(input, out var engineVersion))
-
130 return engineVersion!;
-
131
-
132 throw new InvalidOperationException($"Invalid engine version: {input}");
-
133 }
+
119
+
+
126 public static EngineVersion Parse(string input)
+
127 {
+
128 if (input == null)
+
129 throw new ArgumentNullException(nameof(input));
+
130
+
131 if (TryParse(input, out var engineVersion))
+
132 return engineVersion!;
+
133
+
134 throw new InvalidOperationException($"Invalid engine version: {input}");
+
135 }
-
134
-
- -
139 {
-
140 }
+
136
+
+ +
141 {
+
142 }
-
141
-
- -
147 {
-
148 if (other == null)
-
149 throw new ArgumentNullException(nameof(other));
-
150
-
151 Version = other.Version;
-
152 Engine = other.Engine;
-
153 SourceSHA = other.SourceSHA;
- -
155 }
+
143
+
+ +
149 {
+
150 if (other == null)
+
151 throw new ArgumentNullException(nameof(other));
+
152
+
153 Version = other.Version;
+
154 Engine = other.Engine;
+
155 SourceSHA = other.SourceSHA;
+ +
157 }
-
156
-
-
158 public bool Equals(EngineVersion other)
-
159 {
-
160 // https://github.com/dotnet/roslyn-analyzers/issues/2875
-
161#pragma warning disable CA1062 // Validate arguments of public methods
-
162 return other!.Version?.Semver() == Version?.Semver()
-
163 && other.Engine == Engine
-
164 && (other.SourceSHA == SourceSHA
-
165 || (other.SourceSHA != null
-
166 && SourceSHA != null
-
167 && other.SourceSHA.Equals(SourceSHA, StringComparison.OrdinalIgnoreCase)))
-
168 && other.CustomIteration == CustomIteration;
-
169#pragma warning restore CA1062 // Validate arguments of public methods
-
170 }
+
158
+
+
160 public bool Equals(EngineVersion other)
+
161 {
+
162 // https://github.com/dotnet/roslyn-analyzers/issues/2875
+
163#pragma warning disable CA1062 // Validate arguments of public methods
+
164 return other!.Version?.Semver() == Version?.Semver()
+
165 && other.Engine == Engine
+
166 && (other.SourceSHA == SourceSHA
+
167 || (other.SourceSHA != null
+
168 && SourceSHA != null
+
169 && other.SourceSHA.Equals(SourceSHA, StringComparison.OrdinalIgnoreCase)))
+
170 && other.CustomIteration == CustomIteration;
+
171#pragma warning restore CA1062 // Validate arguments of public methods
+
172 }
-
171
-
173 public override bool Equals(object obj)
-
174 => obj is EngineVersion other && Equals(other);
-
175
-
-
177 public override string ToString()
-
178 {
-
179 var isByond = Engine == EngineType.Byond;
-
180
-
181 // BYOND encodes differently for backwards compatibility
-
182 var enginePrefix = !isByond
-
183 ? $"{Engine}-"
-
184 : String.Empty;
-
185 var displayedVersion = isByond
-
186 ? (CustomIteration.HasValue
-
187 ? new Version(Version!.Major, Version.Minor, CustomIteration.Value)
-
188 : Version!).ToString()
-
189 : SourceSHA;
-
190 var displayedCustomIteration = !isByond && CustomIteration.HasValue
-
191 ? $"-{CustomIteration}"
-
192 : String.Empty;
-
193 return $"{enginePrefix}{displayedVersion}{displayedCustomIteration}";
-
194 }
+
173
+
175 public override bool Equals(object obj)
+
176 => obj is EngineVersion other && Equals(other);
+
177
+
+
179 public override string ToString()
+
180 {
+
181 var isByond = Engine == EngineType.Byond;
+
182
+
183 // BYOND encodes differently for backwards compatibility
+
184 var enginePrefix = !isByond
+
185 ? $"{Engine}-"
+
186 : String.Empty;
+
187 var displayedVersion = isByond
+
188 ? (CustomIteration.HasValue
+
189 ? new Version(Version!.Major, Version.Minor, CustomIteration.Value)
+
190 : Version!).ToString()
+
191 : SourceSHA;
+
192 var displayedCustomIteration = !isByond && CustomIteration.HasValue
+
193 ? $"-{CustomIteration}"
+
194 : String.Empty;
+
195 return $"{enginePrefix}{displayedVersion}{displayedCustomIteration}";
+
196 }
-
195
-
197 public override int GetHashCode() => ToString().GetHashCode();
-
198 }
+
197
+
199 public override int GetHashCode() => ToString().GetHashCode();
+
200 }
-
199}
+
201}
Information about an engine installation.
-
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
- -
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
-
static EngineVersion Parse(string input)
Parses a stringified EngineVersion.
+
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
+ +
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
+
static EngineVersion Parse(string input)
Parses a stringified EngineVersion.
override bool Equals(object obj)
-
EngineVersion()
Initializes a new instance of the EngineVersion class.
- -
EngineVersion(EngineVersion other)
Initializes a new instance of the EngineVersion class.
-
string? SourceSHA
The git commit SHA of the engine. Currently only valid when Engine is EngineType.OpenDream.
+
EngineVersion()
Initializes a new instance of the EngineVersion class.
+ +
EngineVersion(EngineVersion other)
Initializes a new instance of the EngineVersion class.
+
string? SourceSHA
The git commit SHA of the engine. Currently only valid when Engine is EngineType.OpenDream.
-
int? CustomIteration
The revision of the custom build.
+
int? CustomIteration
The revision of the custom build.
static readonly char[] DashChar
An array of a single '-' char.
Sanity limits to prevent users from overloading.
Definition Limits.cs:9
const int MaximumCommitShaLength
Length limit for git commit SHAs.
Definition Limits.cs:28
diff --git a/_entity_id_8cs_source.html b/_entity_id_8cs_source.html index 4a8b247cfc..0fd8bd58bb 100644 --- a/_entity_id_8cs_source.html +++ b/_entity_id_8cs_source.html @@ -87,14 +87,14 @@ $(document).ready(function() { init_codefold(0); });
6 public class EntityId
7 {
-
11 [RequestOptions(FieldPresence.Required)]
-
12 [RequestOptions(FieldPresence.Ignored, PutOnly = true)]
-
13 public virtual long? Id { get; set; }
-
14 }
+
12 [RequestOptions(FieldPresence.Required)]
+
13 [RequestOptions(FieldPresence.Ignored, PutOnly = true)]
+
14 public virtual long? Id { get; set; }
+
15 }
-
15}
+
16}
Common base of entities with IDs.
Definition EntityId.cs:7
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
FieldPresence
Indicates whether a request field is Required or Ignored.
diff --git a/_error_message_exception_8cs_source.html b/_error_message_exception_8cs_source.html index 9b824f5419..f3a896fb7f 100644 --- a/_error_message_exception_8cs_source.html +++ b/_error_message_exception_8cs_source.html @@ -120,7 +120,7 @@ $(document).ready(function() { init_codefold(0); });
Represents an error message returned by the server.
-
string? AdditionalData
Additional data associated with the error message.
+
string? AdditionalData
Additional data associated with the error message.
Exception representing ErrorMessageResponses.
ErrorMessageException(ErrorCode errorCode)
Initializes a new instance of the ErrorMessageException class.
string? AdditionalData
The ErrorMessageResponse.AdditionalData.
diff --git a/_error_message_response_8cs_source.html b/_error_message_response_8cs_source.html index fd43adff1c..e8463fa545 100644 --- a/_error_message_response_8cs_source.html +++ b/_error_message_response_8cs_source.html @@ -92,42 +92,42 @@ $(document).ready(function() { init_codefold(0); });
11 public sealed class ErrorMessageResponse
12 {
-
16 public Version? ServerApiVersion { get; set; }
-
17
-
21 public string? Message { get; set; }
-
22
-
26 [ResponseOptions]
-
27 public string? AdditionalData { get; set; }
-
28
-
32 [EnumDataType(typeof(ErrorCode))]
-
33 [JsonProperty(Required = Required.Always)]
-
34 public ErrorCode ErrorCode { get; set; }
-
35
-
- -
40 {
-
41 }
+
17 public Version? ServerApiVersion { get; set; }
+
18
+
23 public string? Message { get; set; }
+
24
+
29 [ResponseOptions]
+
30 public string? AdditionalData { get; set; }
+
31
+
35 [EnumDataType(typeof(ErrorCode))]
+
36 [JsonProperty(Required = Required.Always)]
+
37 public ErrorCode ErrorCode { get; set; }
+
38
+
+ +
43 {
+
44 }
-
42
-
- -
48 {
-
49 ErrorCode = errorCode;
-
50 Message = errorCode.Describe();
- -
52 }
+
45
+
+ +
51 {
+
52 ErrorCode = errorCode;
+
53 Message = errorCode.Describe();
+ +
55 }
-
53 }
+
56 }
-
54}
+
57}
Represents the header that must be present for every server request.
Definition ApiHeaders.cs:25
static readonly Version Version
Get the version of the Api the caller is using.
Definition ApiHeaders.cs:69
Represents an error message returned by the server.
-
Version? ServerApiVersion
The version of the API the server is using.
-
ErrorMessageResponse(ErrorCode errorCode)
Initializes a new instance of the ErrorMessageResponse class.
-
string? Message
A human readable description of the error.
-
ErrorMessageResponse()
Initializes a new instance of the ErrorMessageResponse class.
-
string? AdditionalData
Additional data associated with the error message.
+
Version? ServerApiVersion
The version of the API the server is using.
+
ErrorMessageResponse(ErrorCode errorCode)
Initializes a new instance of the ErrorMessageResponse class.
+
string? Message
A human-readable description of the error.
+
ErrorMessageResponse()
Initializes a new instance of the ErrorMessageResponse class.
+
string? AdditionalData
Additional data associated with the error message.
ErrorCode
Types of Response.ErrorMessageResponses that the API may return.
Definition ErrorCode.cs:12
@ Required
DMAPI validation must suceed for the deployment to succeed.
diff --git a/_general_configuration_8cs_source.html b/_general_configuration_8cs_source.html index 2653ffefa2..ba9a75493b 100644 --- a/_general_configuration_8cs_source.html +++ b/_general_configuration_8cs_source.html @@ -205,10 +205,10 @@ $(document).ready(function() { init_codefold(0); });
206}
Base class for Response.ServerInformationResponse.
-
uint UserGroupLimit
The maximum number of user groups allowed.
-
uint MinimumPasswordLength
Minimum length of database user passwords.
- -
uint InstanceLimit
The maximum number of Instances allowed.
+
uint UserGroupLimit
The maximum number of user groups allowed.
+
uint MinimumPasswordLength
Minimum length of database user passwords.
+ +
uint InstanceLimit
The maximum number of Instances allowed.
uint? DeploymentDirectoryCopyTasksPerCore
A limit on the amount of tasks used for asynchronous I/O when copying directories during the deployme...
const string Section
The key for the Microsoft.Extensions.Configuration.IConfigurationSection the GeneralConfiguration res...
diff --git a/_git_hub_remote_features_8cs_source.html b/_git_hub_remote_features_8cs_source.html index 17339d958f..7ed8704452 100644 --- a/_git_hub_remote_features_8cs_source.html +++ b/_git_hub_remote_features_8cs_source.html @@ -182,9 +182,9 @@ $(document).ready(function() { init_codefold(0); });
Represents configurable settings for a git repository.
string? AccessToken
The token/password to access the git repository with. Can also be a TGS encoded app private key....
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
-
string? Comment
Optional comment about the test.
-
int Number
The number of the test merge source.
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
string? Comment
Optional comment about the test.
+
int Number
The number of the test merge source.
GitHubRemoteFeatures(IGitHubServiceFactory gitHubServiceFactory, ILogger< GitHubRemoteFeatures > logger, Uri remoteUrl)
Initializes a new instance of the GitHubRemoteFeatures class.
diff --git a/_git_lab_remote_features_8cs_source.html b/_git_lab_remote_features_8cs_source.html index 7a4e40773d..f1a4df0651 100644 --- a/_git_lab_remote_features_8cs_source.html +++ b/_git_lab_remote_features_8cs_source.html @@ -165,13 +165,13 @@ $(document).ready(function() { init_codefold(0); });
92}
-
string? Author
The author of the test merge source.
+
string? Author
The author of the test merge source.
Represents configurable settings for a git repository.
string? AccessToken
The token/password to access the git repository with. Can also be a TGS encoded app private key....
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
-
string? Comment
Optional comment about the test.
-
int Number
The number of the test merge source.
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
string? Comment
Optional comment about the test.
+
int Number
The number of the test merge source.
override async ValueTask< Models.TestMerge > GetTestMergeImpl(TestMergeParameters parameters, RepositorySettings repositorySettings, CancellationToken cancellationToken)
diff --git a/_git_remote_features_base_8cs_source.html b/_git_remote_features_base_8cs_source.html index 00560fe587..1f3cec76ca 100644 --- a/_git_remote_features_base_8cs_source.html +++ b/_git_remote_features_base_8cs_source.html @@ -161,7 +161,7 @@ $(document).ready(function() { init_codefold(0); });
98}
Represents configurable settings for a git repository.
-
int Number
The number of the test merge source.
+
int Number
The number of the test merge source.
readonly Dictionary< TestMergeParameters, Models.TestMerge > cachedLookups
Cache of created Models.TestMerges.
diff --git a/_instance_client_8cs_source.html b/_instance_client_8cs_source.html index 8c05b133e9..d57d9079b3 100644 --- a/_instance_client_8cs_source.html +++ b/_instance_client_8cs_source.html @@ -132,7 +132,7 @@ $(document).ready(function() { init_codefold(0); });
60 }
61}
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Metadata about a server instance.
Definition Instance.cs:9
diff --git a/_instance_controller_8cs_source.html b/_instance_controller_8cs_source.html index 440a943e5d..2e06b5c710 100644 --- a/_instance_controller_8cs_source.html +++ b/_instance_controller_8cs_source.html @@ -898,9 +898,9 @@ $(document).ready(function() { init_codefold(0); });
905}
-
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
-
uint InstanceLimit
The maximum number of Instances allowed.
-
string? Identifier
The server's identifier.
+
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
+
uint InstanceLimit
The maximum number of Instances allowed.
+
string? Identifier
The server's identifier.
Represents a set of server permissions.
InstanceManagerRights? InstanceManagerRights
The Rights.InstanceManagerRights for the user.
@@ -910,7 +910,7 @@ $(document).ready(function() { init_codefold(0); });
Represents an error message returned by the server.
- +
Routes to a server actions.
Definition Routes.cs:9
const string InstanceManager
The Models.Instance controller.
Definition Routes.cs:48
diff --git a/_instance_manager_8cs_source.html b/_instance_manager_8cs_source.html index 58240cc37b..eaea9039cd 100644 --- a/_instance_manager_8cs_source.html +++ b/_instance_manager_8cs_source.html @@ -718,7 +718,7 @@ $(document).ready(function() { init_codefold(0); }); -
string? Identifier
The server's identifier.
+
string? Identifier
The server's identifier.
Extension methods for the ValueTask and ValueTask<TResult> classes.
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
diff --git a/_instance_manager_client_8cs_source.html b/_instance_manager_client_8cs_source.html index 9383db9b7d..e284ce69a3 100644 --- a/_instance_manager_client_8cs_source.html +++ b/_instance_manager_client_8cs_source.html @@ -136,7 +136,7 @@ $(document).ready(function() { init_codefold(0); });
59}
Common base of entities with IDs.
Definition EntityId.cs:7
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Metadata about a server instance.
Definition Instance.cs:9
A request to create an Instance.
A request to update an Instance.
diff --git a/_instance_permission_set_client_8cs_source.html b/_instance_permission_set_client_8cs_source.html index ea57805578..18536d42c8 100644 --- a/_instance_permission_set_client_8cs_source.html +++ b/_instance_permission_set_client_8cs_source.html @@ -132,7 +132,7 @@ $(document).ready(function() { init_codefold(0); });
60 }
61}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.InstancePermissionSet
Represents a PermissionSets permissions in an Instance.
Definition InstancePermissionSet.cs:13
Tgstation.Server.Api.Models.Request.InstancePermissionSetRequest
A request to update an instance permission set.
Definition InstancePermissionSetRequest.cs:9
diff --git a/_instance_permission_set_controller_8cs_source.html b/_instance_permission_set_controller_8cs_source.html index 78005e872b..e0b8283b15 100644 --- a/_instance_permission_set_controller_8cs_source.html +++ b/_instance_permission_set_controller_8cs_source.html @@ -299,7 +299,7 @@ $(document).ready(function() { init_codefold(0); });
264 }
265}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.InstancePermissionSet.PermissionSetId
long PermissionSetId
The EntityId.Id of the PermissionSet the InstancePermissionSet belongs to.
Definition InstancePermissionSet.cs:18
Tgstation.Server.Api.Models.Request.InstancePermissionSetRequest
A request to update an instance permission set.
Definition InstancePermissionSetRequest.cs:9
diff --git a/_irc_provider_8cs_source.html b/_irc_provider_8cs_source.html index f8077ad01e..f6d2f7991a 100644 --- a/_irc_provider_8cs_source.html +++ b/_irc_provider_8cs_source.html @@ -759,7 +759,7 @@ $(document).ready(function() { init_codefold(0); });
759}
Exception
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:177
+
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:179
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
Tgstation.Server.Api.Models.IrcConnectionStringBuilder
ChatConnectionStringBuilder for ChatProvider.Irc.
Definition IrcConnectionStringBuilder.cs:13
Tgstation.Server.Host.Components.Chat.ChannelRepresentation
Represents a Providers.IProvider channel.
Definition ChannelRepresentation.cs:13
diff --git a/_job_controller_8cs_source.html b/_job_controller_8cs_source.html index f76e437acf..8d0ed97a48 100644 --- a/_job_controller_8cs_source.html +++ b/_job_controller_8cs_source.html @@ -232,7 +232,7 @@ $(document).ready(function() { init_codefold(0); });
192 }
193}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
Tgstation.Server.Api.Models.Response.JobResponse
Represents a long running job on the server. Model is read-only, updates attempt to cancel the job.
Definition JobResponse.cs:7
diff --git a/_job_response_8cs_source.html b/_job_response_8cs_source.html index a55326ae45..7d3fdeaba6 100644 --- a/_job_response_8cs_source.html +++ b/_job_response_8cs_source.html @@ -87,27 +87,27 @@ $(document).ready(function() { init_codefold(0); });
6 public sealed class JobResponse : Internal.Job
7 {
-
11 public long? InstanceId { get; set; }
-
12
-
16 public UserName? StartedBy { get; set; }
-
17
-
21 [ResponseOptions]
-
22 public UserName? CancelledBy { get; set; }
-
23
-
27 [ResponseOptions]
-
28 public int? Progress { get; set; }
-
29
-
33 [ResponseOptions]
-
34 public string? Stage { get; set; }
-
35 }
+
12 public long? InstanceId { get; set; }
+
13
+
17 public UserName? StartedBy { get; set; }
+
18
+
22 [ResponseOptions]
+
23 public UserName? CancelledBy { get; set; }
+
24
+
29 [ResponseOptions]
+
30 public int? Progress { get; set; }
+
31
+
36 [ResponseOptions]
+
37 public string? Stage { get; set; }
+
38 }
-
36}
+
39}
Tgstation.Server.Api.Models.Response.JobResponse
Represents a long running job on the server. Model is read-only, updates attempt to cancel the job.
Definition JobResponse.cs:7
-
Tgstation.Server.Api.Models.Response.JobResponse.Progress
int? Progress
Optional progress between 0 and 100 inclusive.
Definition JobResponse.cs:28
-
Tgstation.Server.Api.Models.Response.JobResponse.StartedBy
UserName? StartedBy
The UserResponse that started the job.
Definition JobResponse.cs:16
-
Tgstation.Server.Api.Models.Response.JobResponse.InstanceId
long? InstanceId
The EntityId.Id of the Instance.
Definition JobResponse.cs:11
-
Tgstation.Server.Api.Models.Response.JobResponse.Stage
string? Stage
Optional description of the job's current .
Definition JobResponse.cs:34
-
Tgstation.Server.Api.Models.Response.JobResponse.CancelledBy
UserName? CancelledBy
The UserResponse that cancelled the job.
Definition JobResponse.cs:22
+
Tgstation.Server.Api.Models.Response.JobResponse.Progress
int? Progress
Optional progress between 0 and 100 inclusive.
Definition JobResponse.cs:30
+
Tgstation.Server.Api.Models.Response.JobResponse.StartedBy
UserName? StartedBy
The UserResponse that started the job.
Definition JobResponse.cs:17
+
Tgstation.Server.Api.Models.Response.JobResponse.InstanceId
long? InstanceId
The EntityId.Id of the Instance.
Definition JobResponse.cs:12
+
Tgstation.Server.Api.Models.Response.JobResponse.Stage
string? Stage
Optional description of the job's current progress.
Definition JobResponse.cs:37
+
Tgstation.Server.Api.Models.Response.JobResponse.CancelledBy
UserName? CancelledBy
The UserResponse that cancelled the job.
Definition JobResponse.cs:23
Tgstation.Server.Api.Models.UserName
Base class for user names.
Definition UserName.cs:7
Tgstation.Server.Api.Models.Response
Definition AdministrationResponse.cs:6
diff --git a/_job_service_8cs_source.html b/_job_service_8cs_source.html index 9147b0278a..e5df99abf3 100644 --- a/_job_service_8cs_source.html +++ b/_job_service_8cs_source.html @@ -608,13 +608,13 @@ $(document).ready(function() { init_codefold(0); });
559}
Exception
IDisposable
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
Tgstation.Server.Api.Models.Internal.Job.Description
string? Description
English description of the Job.
Definition Job.cs:24
-
Tgstation.Server.Api.Models.Internal.Job.ErrorCode
ErrorCode? ErrorCode
The Models.ErrorCode associated with the Job if any.
Definition Job.cs:30
-
Tgstation.Server.Api.Models.Internal.Job.Cancelled
bool? Cancelled
If the Job was cancelled.
Definition Job.cs:54
-
Tgstation.Server.Api.Models.Internal.Job.ExceptionDetails
string? ExceptionDetails
Details of any exceptions caught during the Job.
Definition Job.cs:36
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
Tgstation.Server.Api.Models.Internal.Job.Description
string? Description
English description of the Job.
Definition Job.cs:25
+
Tgstation.Server.Api.Models.Internal.Job.ErrorCode
ErrorCode? ErrorCode
The Models.ErrorCode associated with the Job if any.
Definition Job.cs:31
+
Tgstation.Server.Api.Models.Internal.Job.Cancelled
bool? Cancelled
If the Job was cancelled.
Definition Job.cs:56
+
Tgstation.Server.Api.Models.Internal.Job.ExceptionDetails
string? ExceptionDetails
Details of any exceptions caught during the Job.
Definition Job.cs:37
Tgstation.Server.Api.Models.Response.JobResponse
Represents a long running job on the server. Model is read-only, updates attempt to cancel the job.
Definition JobResponse.cs:7
-
Tgstation.Server.Api.Models.UserName.Name
override? string Name
Definition UserName.cs:11
+
Tgstation.Server.Api.Models.UserName.Name
override? string Name
Definition UserName.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
Tgstation.Server.Host.Jobs.JobException
Operation exceptions thrown from the context of a Models.Job.
Definition JobException.cs:11
diff --git a/_jobs_client_8cs_source.html b/_jobs_client_8cs_source.html index d48b2e5a28..77ed20340d 100644 --- a/_jobs_client_8cs_source.html +++ b/_jobs_client_8cs_source.html @@ -119,7 +119,7 @@ $(document).ready(function() { init_codefold(0); });
45}
Tgstation.Server.Api.Models.EntityId
Common base of entities with IDs.
Definition EntityId.cs:7
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Response.JobResponse
Represents a long running job on the server. Model is read-only, updates attempt to cancel the job.
Definition JobResponse.cs:7
Tgstation.Server.Api.Routes
Routes to a server actions.
Definition Routes.cs:9
diff --git a/_jobs_hub_group_mapper_8cs_source.html b/_jobs_hub_group_mapper_8cs_source.html index 507a2edd43..eee86fb739 100644 --- a/_jobs_hub_group_mapper_8cs_source.html +++ b/_jobs_hub_group_mapper_8cs_source.html @@ -260,7 +260,7 @@ $(document).ready(function() { init_codefold(0); });
205}
IHostedService
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Internal.InstancePermissionSet.PermissionSetId
long PermissionSetId
The EntityId.Id of the PermissionSet the InstancePermissionSet belongs to.
Definition InstancePermissionSet.cs:18
Tgstation.Server.Api.Models.PermissionSet.Id
override? long Id
Definition PermissionSet.cs:15
Tgstation.Server.Host.Jobs.JobsHubGroupMapper
Handles mapping groups for the JobsHub.
Definition JobsHubGroupMapper.cs:24
diff --git a/_log_file_response_8cs_source.html b/_log_file_response_8cs_source.html index 0e1ebefea8..867e41962e 100644 --- a/_log_file_response_8cs_source.html +++ b/_log_file_response_8cs_source.html @@ -89,16 +89,16 @@ $(document).ready(function() { init_codefold(0); });
8 public sealed class LogFileResponse : FileTicketResponse
9 {
-
13 public string? Name { get; set; }
-
14
-
18 public DateTimeOffset LastModified { get; set; }
-
19 }
+
14 public string? Name { get; set; }
+
15
+
19 public DateTimeOffset LastModified { get; set; }
+
20 }
-
20}
+
21}
Tgstation.Server.Api.Models.Response.FileTicketResponse
Response for when file transfers are necessary.
Definition FileTicketResponse.cs:7
Tgstation.Server.Api.Models.Response.LogFileResponse
Represents a server log file.
Definition LogFileResponse.cs:9
-
Tgstation.Server.Api.Models.Response.LogFileResponse.LastModified
DateTimeOffset LastModified
The DateTimeOffset of when the log file was modified.
Definition LogFileResponse.cs:18
-
Tgstation.Server.Api.Models.Response.LogFileResponse.Name
string? Name
The name of the log file.
Definition LogFileResponse.cs:13
+
Tgstation.Server.Api.Models.Response.LogFileResponse.LastModified
DateTimeOffset LastModified
The DateTimeOffset of when the log file was modified.
Definition LogFileResponse.cs:19
+
Tgstation.Server.Api.Models.Response.LogFileResponse.Name
string? Name
The name of the log file.
Definition LogFileResponse.cs:14
Tgstation.Server.Api.Models.Response
Definition AdministrationResponse.cs:6
diff --git a/_login_authority_8cs_source.html b/_login_authority_8cs_source.html index ea9a5657ab..c5951da069 100644 --- a/_login_authority_8cs_source.html +++ b/_login_authority_8cs_source.html @@ -377,9 +377,9 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.ApiHeaders
Represents the header that must be present for every server request.
Definition ApiHeaders.cs:25
Tgstation.Server.Api.ApiHeaders.OAuthCode
string? OAuthCode
The OAuth code in use.
Definition ApiHeaders.cs:119
Tgstation.Server.Api.HeadersException
Thrown when trying to generate ApiHeaders from Microsoft.AspNetCore.Http.Headers.RequestHeaders fails...
Definition HeadersException.cs:9
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
-
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.Message
string? Message
A human readable description of the error.
Definition ErrorMessageResponse.cs:21
+
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.Message
string? Message
A human-readable description of the error.
Definition ErrorMessageResponse.cs:23
Tgstation.Server.Api.Models.Response.TokenResponse.ParseJwt
JsonWebToken ParseJwt()
Parses the Bearer as a JsonWebToken.
Tgstation.Server.Host.Authority.Core.AuthorityBase
Base implementation of IAuthority.
Definition AuthorityBase.cs:19
Tgstation.Server.Host.Authority.Core.AuthorityBase.Unauthorized< TResult >
static AuthorityResponse< TResult > Unauthorized< TResult >()
Generates a HttpFailureResponse.Unauthorized type AuthorityResponse<TResult>.
diff --git a/_my_sql_database_context_8cs_source.html b/_my_sql_database_context_8cs_source.html index f34e8ae283..84ff2cdd5c 100644 --- a/_my_sql_database_context_8cs_source.html +++ b/_my_sql_database_context_8cs_source.html @@ -184,8 +184,8 @@ $(document).ready(function() { init_codefold(0); });
107 }
108}
-
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString
string? ConnectionString
The information used to connect to the Provider.
Definition ChatBotSettings.cs:44
-
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:16
+
Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString
string? ConnectionString
The information used to connect to the Provider.
Definition ChatBotSettings.cs:46
+
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:17
Tgstation.Server.Host.Configuration.DatabaseConfiguration
Configuration options for the Database.DatabaseContext.
Definition DatabaseConfiguration.cs:10
Tgstation.Server.Host.Configuration.DatabaseConfiguration.ServerVersion
string? ServerVersion
The string form of the global::System.Version of the target server.
Definition DatabaseConfiguration.cs:40
Tgstation.Server.Host.Configuration.DatabaseConfiguration.ConnectionString
string? ConnectionString
The connection string for the database.
Definition DatabaseConfiguration.cs:30
diff --git a/_paginated_client_8cs_source.html b/_paginated_client_8cs_source.html index b260dbc3f4..1efeccdda9 100644 --- a/_paginated_client_8cs_source.html +++ b/_paginated_client_8cs_source.html @@ -195,7 +195,7 @@ $(document).ready(function() { init_codefold(0); });
125}
Tgstation.Server.Api.Models.Response.PaginatedResponse
Represents a paginated set of models.
Definition PaginatedResponse.cs:11
-
Tgstation.Server.Api.Models.Response.PaginatedResponse.PageSize
int PageSize
The current size of pages in the query.
Definition PaginatedResponse.cs:26
+
Tgstation.Server.Api.Models.Response.PaginatedResponse.PageSize
int PageSize
The current size of pages in the query.
Definition PaginatedResponse.cs:28
Tgstation.Server.Client.ApiClient
Definition ApiClient.cs:35
Tgstation.Server.Client.ApiConflictException
Occurs when the server returns a bad request response if the ApiException.ErrorCode is present....
Definition ApiConflictException.cs:12
Tgstation.Server.Client.PaginatedClient
Client that deals with getting paginated results.
Definition PaginatedClient.cs:17
diff --git a/_paginated_response_8cs_source.html b/_paginated_response_8cs_source.html index 0a39993201..f6f05feaa9 100644 --- a/_paginated_response_8cs_source.html +++ b/_paginated_response_8cs_source.html @@ -93,19 +93,19 @@ $(document).ready(function() { init_codefold(0); });
15 [Required]
16 public ICollection<TModel>? Content { get; set; }
17
-
21 public int TotalPages { get; set; }
-
22
-
26 public int PageSize { get; set; }
-
27
-
31 public int TotalItems { get; set; }
-
32 }
+
22 public int TotalPages { get; set; }
+
23
+
28 public int PageSize { get; set; }
+
29
+
34 public int TotalItems { get; set; }
+
35 }
-
33}
+
36}
Tgstation.Server.Api.Models.Response.PaginatedResponse
Represents a paginated set of models.
Definition PaginatedResponse.cs:11
-
Tgstation.Server.Api.Models.Response.PaginatedResponse.TotalPages
int TotalPages
The total number of pages in the query.
Definition PaginatedResponse.cs:21
+
Tgstation.Server.Api.Models.Response.PaginatedResponse.TotalPages
int TotalPages
The total number of pages in the query.
Definition PaginatedResponse.cs:22
Tgstation.Server.Api.Models.Response.PaginatedResponse.Content
ICollection< TModel >? Content
The ICollection<T> of the returned TModel s.
Definition PaginatedResponse.cs:16
-
Tgstation.Server.Api.Models.Response.PaginatedResponse.PageSize
int PageSize
The current size of pages in the query.
Definition PaginatedResponse.cs:26
-
Tgstation.Server.Api.Models.Response.PaginatedResponse.TotalItems
int TotalItems
The total items across all pages.
Definition PaginatedResponse.cs:31
+
Tgstation.Server.Api.Models.Response.PaginatedResponse.PageSize
int PageSize
The current size of pages in the query.
Definition PaginatedResponse.cs:28
+
Tgstation.Server.Api.Models.Response.PaginatedResponse.TotalItems
int TotalItems
The total items across all pages.
Definition PaginatedResponse.cs:34
Tgstation.Server.Api.Models.Response
Definition AdministrationResponse.cs:6
Tgstation.Server.Api.Models.DMApiValidationMode.Required
@ Required
DMAPI validation must suceed for the deployment to succeed.
diff --git a/_port_allocator_8cs_source.html b/_port_allocator_8cs_source.html index a0dfc505e7..1779557b45 100644 --- a/_port_allocator_8cs_source.html +++ b/_port_allocator_8cs_source.html @@ -249,7 +249,7 @@ $(document).ready(function() { init_codefold(0); });
194}
Exception
IDisposable
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Host.Configuration.SwarmConfiguration
Configuration for the server swarm system.
Definition SwarmConfiguration.cs:13
Tgstation.Server.Host.Extensions.SocketExtensions
Extension methods for the Socket class.
Definition SocketExtensions.cs:13
Tgstation.Server.Host.Extensions.SocketExtensions.BindTest
static void BindTest(IPlatformIdentifier platformIdentifier, ushort port, bool includeIPv6, bool udp)
Attempt to exclusively bind to a given port .
Definition SocketExtensions.cs:21
diff --git a/_posix_byond_installer_8cs_source.html b/_posix_byond_installer_8cs_source.html index 411914822a..2fd2769496 100644 --- a/_posix_byond_installer_8cs_source.html +++ b/_posix_byond_installer_8cs_source.html @@ -205,7 +205,7 @@ $(document).ready(function() { init_codefold(0); });
139}
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:30
+
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:31
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
Tgstation.Server.Host.Components.Engine.ByondInstallerBase
Base implementation of IEngineInstaller for EngineType.Byond.
Definition ByondInstallerBase.cs:20
diff --git a/_posix_watchdog_8cs_source.html b/_posix_watchdog_8cs_source.html index c93046277f..b2ddd9c640 100644 --- a/_posix_watchdog_8cs_source.html +++ b/_posix_watchdog_8cs_source.html @@ -159,7 +159,7 @@ $(document).ready(function() { init_codefold(0); });
100}
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters
Launch settings for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:10
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:39
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:42
Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider
A IDmbProvider that uses filesystem links to change directory structure underneath the server process...
Definition SwappableDmbProvider.cs:14
Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog
A IWatchdog that, instead of killing servers for updates, uses the wonders of filesystem links to swa...
Definition AdvancedWatchdog.cs:27
diff --git a/_repository_8cs_source.html b/_repository_8cs_source.html index 2e4077165f..10f7cb7ab1 100644 --- a/_repository_8cs_source.html +++ b/_repository_8cs_source.html @@ -1237,9 +1237,9 @@ $(document).ready(function() { init_codefold(0); });
1250}
Tgstation.Server.Api.Models.RepositorySettings
Represents configurable settings for a git repository.
Definition RepositorySettings.cs:9
Tgstation.Server.Api.Models.TestMergeParameters
Parameters for creating a TestMerge.
Definition TestMergeParameters.cs:9
-
Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
Definition TestMergeParameters.cs:20
-
Tgstation.Server.Api.Models.TestMergeParameters.Comment
string? Comment
Optional comment about the test.
Definition TestMergeParameters.cs:27
-
Tgstation.Server.Api.Models.TestMergeParameters.Number
int Number
The number of the test merge source.
Definition TestMergeParameters.cs:13
+
Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
Definition TestMergeParameters.cs:22
+
Tgstation.Server.Api.Models.TestMergeParameters.Comment
string? Comment
Optional comment about the test.
Definition TestMergeParameters.cs:30
+
Tgstation.Server.Api.Models.TestMergeParameters.Number
int Number
The number of the test merge source.
Definition TestMergeParameters.cs:14
Tgstation.Server.Host.Components.Repository.Repository
Definition Repository.cs:27
Tgstation.Server.Host.Components.Repository.Repository.Reference
string Reference
The current reference the IRepository HEAD is using. This can be a branch or tag.
Definition Repository.cs:74
Tgstation.Server.Host.Components.Repository.Repository.commands
readonly ILibGit2Commands commands
The ILibGit2Commands for the Repository.
Definition Repository.cs:87
diff --git a/_repository_client_8cs_source.html b/_repository_client_8cs_source.html index 910ca006f2..4657ae4bc3 100644 --- a/_repository_client_8cs_source.html +++ b/_repository_client_8cs_source.html @@ -120,7 +120,7 @@ $(document).ready(function() { init_codefold(0); });
50 }
51}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Request.RepositoryCreateRequest
Represents a request to clone the repository.
Definition RepositoryCreateRequest.cs:11
Tgstation.Server.Api.Models.Request.RepositoryUpdateRequest
Represents a request to change the repository.
Definition RepositoryUpdateRequest.cs:12
diff --git a/_repository_controller_8cs_source.html b/_repository_controller_8cs_source.html index 93f530edfe..2231a6170d 100644 --- a/_repository_controller_8cs_source.html +++ b/_repository_controller_8cs_source.html @@ -671,7 +671,7 @@ $(document).ready(function() { init_codefold(0); });
657}
Exception
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Request.RepositoryCreateRequest
Represents a request to clone the repository.
Definition RepositoryCreateRequest.cs:11
Tgstation.Server.Api.Models.Request.RepositoryUpdateRequest
Represents a request to change the repository.
Definition RepositoryUpdateRequest.cs:12
diff --git a/_repository_update_service_8cs_source.html b/_repository_update_service_8cs_source.html index dde3e943e9..e5dd849a3c 100644 --- a/_repository_update_service_8cs_source.html +++ b/_repository_update_service_8cs_source.html @@ -709,7 +709,7 @@ $(document).ready(function() { init_codefold(0); });
675}
Exception
IQueryable
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.RepositoryApiBase.Reference
string? Reference
The branch or tag HEAD points to.
Definition RepositoryApiBase.cs:15
Tgstation.Server.Api.Models.RepositorySettings
Represents configurable settings for a git repository.
Definition RepositorySettings.cs:9
diff --git a/_rest_server_client_factory_8cs_source.html b/_rest_server_client_factory_8cs_source.html index 9652b462c1..78dfd47433 100644 --- a/_rest_server_client_factory_8cs_source.html +++ b/_rest_server_client_factory_8cs_source.html @@ -264,7 +264,7 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.ApiHeaders
Represents the header that must be present for every server request.
Definition ApiHeaders.cs:25
Tgstation.Server.Api.Models.Response.ServerInformationResponse
Represents basic server information.
Definition ServerInformationResponse.cs:10
Tgstation.Server.Api.Models.Response.TokenResponse
Represents a JWT returned by the API.
Definition TokenResponse.cs:9
-
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:13
+
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:14
Tgstation.Server.Api.Routes
Routes to a server actions.
Definition Routes.cs:9
Tgstation.Server.Api.Routes.ApiRoot
const string ApiRoot
The root of API methods.
Definition Routes.cs:13
Tgstation.Server.Client.ApiClientFactory
Definition ApiClientFactory.cs:10
diff --git a/_root_controller_8cs_source.html b/_root_controller_8cs_source.html index cb76b47831..711e493f12 100644 --- a/_root_controller_8cs_source.html +++ b/_root_controller_8cs_source.html @@ -261,8 +261,8 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Host.Controllers.RootController.GetControlPanelActionLink
static Tuple< string, string?> GetControlPanelActionLink(Expression< Func< ControlPanelController, IActionResult > > actionExpression)
Gets a Tuple<T1, T2> giving the ControlPanelController and action names for a given actionExpression ...
Definition RootController.cs:76
Tgstation.Server.Host.Controllers.RootController.GetLogo
IActionResult GetLogo()
Retrieve the logo .svg for the webpanel.
Definition RootController.cs:169
Tgstation.Server.Host.Controllers.RootController.controlPanelConfiguration
readonly ControlPanelConfiguration controlPanelConfiguration
The ControlPanelConfiguration for the RootController.
Definition RootController.cs:64
-
Tgstation.Server.Host.Utils.SwaggerConfiguration
Implements various filters for Swashbuckle.
Definition SwaggerConfiguration.cs:29
-
Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
Definition SwaggerConfiguration.cs:38
+
Tgstation.Server.Host.Utils.SwaggerConfiguration
Implements various filters for Swashbuckle.
Definition SwaggerConfiguration.cs:30
+
Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
Definition SwaggerConfiguration.cs:39
Tgstation.Server.Host.System.IAssemblyInformationProvider
For retrieving the Assembly's location.
Definition IAssemblyInformationProvider.cs:11
Tgstation.Server.Host.System.IAssemblyInformationProvider.VersionString
string VersionString
A more verbose version of Version.
Definition IAssemblyInformationProvider.cs:30
Tgstation.Server.Host.System.IPlatformIdentifier
For identifying the current platform.
Definition IPlatformIdentifier.cs:9
diff --git a/_server_information_base_8cs_source.html b/_server_information_base_8cs_source.html index e0014d6f79..8c142a5716 100644 --- a/_server_information_base_8cs_source.html +++ b/_server_information_base_8cs_source.html @@ -89,25 +89,25 @@ $(document).ready(function() { init_codefold(0); });
8 public abstract class ServerInformationBase
9 {
-
13 public uint MinimumPasswordLength { get; set; }
-
14
-
18 public uint InstanceLimit { get; set; }
-
19
-
23 public uint UserLimit { get; set; }
-
24
-
28 public uint UserGroupLimit { get; set; }
-
29
-
33 [ResponseOptions]
-
34 public List<string>? ValidInstancePaths { get; set; }
-
35 }
+
14 public uint MinimumPasswordLength { get; set; }
+
15
+
20 public uint InstanceLimit { get; set; }
+
21
+
26 public uint UserLimit { get; set; }
+
27
+
32 public uint UserGroupLimit { get; set; }
+
33
+
38 [ResponseOptions]
+
39 public List<string>? ValidInstancePaths { get; set; }
+
40 }
-
36}
+
41}
Tgstation.Server.Api.Models.Internal.ServerInformationBase
Base class for Response.ServerInformationResponse.
Definition ServerInformationBase.cs:9
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit
uint UserGroupLimit
The maximum number of user groups allowed.
Definition ServerInformationBase.cs:28
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
Definition ServerInformationBase.cs:34
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength
uint MinimumPasswordLength
Minimum length of database user passwords.
Definition ServerInformationBase.cs:13
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit
uint UserLimit
The maximum number of users allowed.
Definition ServerInformationBase.cs:23
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit
uint InstanceLimit
The maximum number of Instances allowed.
Definition ServerInformationBase.cs:18
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit
uint UserGroupLimit
The maximum number of user groups allowed.
Definition ServerInformationBase.cs:32
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
Definition ServerInformationBase.cs:39
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength
uint MinimumPasswordLength
Minimum length of database user passwords.
Definition ServerInformationBase.cs:14
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit
uint UserLimit
The maximum number of users allowed.
Definition ServerInformationBase.cs:26
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit
uint InstanceLimit
The maximum number of Instances allowed.
Definition ServerInformationBase.cs:20
Tgstation.Server.Api.Models.Internal
Definition ChatBotApiBase.cs:6
diff --git a/_server_information_response_8cs_source.html b/_server_information_response_8cs_source.html index d7cd412f34..0762c84fc2 100644 --- a/_server_information_response_8cs_source.html +++ b/_server_information_response_8cs_source.html @@ -90,31 +90,31 @@ $(document).ready(function() { init_codefold(0); });
9 public sealed class ServerInformationResponse : Internal.ServerInformationBase
10 {
-
14 public Version? Version { get; set; }
-
15
-
19 public Version? ApiVersion { get; set; }
-
20
-
24 public Version? DMApiVersion { get; set; }
-
25
-
29 public bool WindowsHost { get; set; }
-
30
-
34 public Dictionary<OAuthProvider, OAuthProviderInfo>? OAuthProviderInfos { get; set; }
-
35
-
39 public bool UpdateInProgress { get; set; }
-
40
-
44 [ResponseOptions]
-
45 public ICollection<SwarmServerResponse>? SwarmServers { get; set; }
-
46 }
+
15 public Version? Version { get; set; }
+
16
+
21 public Version? ApiVersion { get; set; }
+
22
+
27 public Version? DMApiVersion { get; set; }
+
28
+
32 public bool WindowsHost { get; set; }
+
33
+
37 public Dictionary<OAuthProvider, OAuthProviderInfo>? OAuthProviderInfos { get; set; }
+
38
+
43 public bool UpdateInProgress { get; set; }
+
44
+
48 [ResponseOptions]
+
49 public ICollection<SwarmServerResponse>? SwarmServers { get; set; }
+
50 }
-
47}
+
51}
Tgstation.Server.Api.Models.Response.ServerInformationResponse
Represents basic server information.
Definition ServerInformationResponse.cs:10
-
Tgstation.Server.Api.Models.Response.ServerInformationResponse.WindowsHost
bool WindowsHost
If the server is running on a windows operating system.
Definition ServerInformationResponse.cs:29
-
Tgstation.Server.Api.Models.Response.ServerInformationResponse.ApiVersion
Version? ApiVersion
The Api version of the host.
Definition ServerInformationResponse.cs:19
-
Tgstation.Server.Api.Models.Response.ServerInformationResponse.DMApiVersion
Version? DMApiVersion
The DMAPI interop version the server uses.
Definition ServerInformationResponse.cs:24
-
Tgstation.Server.Api.Models.Response.ServerInformationResponse.SwarmServers
ICollection< SwarmServerResponse >? SwarmServers
A ICollection<T> of connected SwarmServerResponses.
Definition ServerInformationResponse.cs:45
-
Tgstation.Server.Api.Models.Response.ServerInformationResponse.Version
Version? Version
The version of the host.
Definition ServerInformationResponse.cs:14
-
Tgstation.Server.Api.Models.Response.ServerInformationResponse.OAuthProviderInfos
Dictionary< OAuthProvider, OAuthProviderInfo >? OAuthProviderInfos
Map of OAuthProvider to the OAuthProviderInfo for them.
Definition ServerInformationResponse.cs:34
-
Tgstation.Server.Api.Models.Response.ServerInformationResponse.UpdateInProgress
bool UpdateInProgress
If there is a server update in progress.
Definition ServerInformationResponse.cs:39
+
Tgstation.Server.Api.Models.Response.ServerInformationResponse.WindowsHost
bool WindowsHost
If the server is running on a windows operating system.
Definition ServerInformationResponse.cs:32
+
Tgstation.Server.Api.Models.Response.ServerInformationResponse.ApiVersion
Version? ApiVersion
The Api version of the host.
Definition ServerInformationResponse.cs:21
+
Tgstation.Server.Api.Models.Response.ServerInformationResponse.DMApiVersion
Version? DMApiVersion
The DMAPI interop version the server uses.
Definition ServerInformationResponse.cs:27
+
Tgstation.Server.Api.Models.Response.ServerInformationResponse.SwarmServers
ICollection< SwarmServerResponse >? SwarmServers
A ICollection<T> of connected SwarmServerResponses.
Definition ServerInformationResponse.cs:49
+
Tgstation.Server.Api.Models.Response.ServerInformationResponse.Version
Version? Version
The version of the host.
Definition ServerInformationResponse.cs:15
+
Tgstation.Server.Api.Models.Response.ServerInformationResponse.OAuthProviderInfos
Dictionary< OAuthProvider, OAuthProviderInfo >? OAuthProviderInfos
Map of OAuthProvider to the OAuthProviderInfo for them.
Definition ServerInformationResponse.cs:37
+
Tgstation.Server.Api.Models.Response.ServerInformationResponse.UpdateInProgress
bool UpdateInProgress
If there is a server update in progress.
Definition ServerInformationResponse.cs:43
Tgstation.Server.Api.Models.Response
Definition AdministrationResponse.cs:6
diff --git a/_server_update_request_8cs_source.html b/_server_update_request_8cs_source.html index b57ab68b79..bd524e298e 100644 --- a/_server_update_request_8cs_source.html +++ b/_server_update_request_8cs_source.html @@ -89,16 +89,16 @@ $(document).ready(function() { init_codefold(0); });
8 public sealed class ServerUpdateRequest
9 {
-
13 [RequestOptions(FieldPresence.Required)]
-
14 public Version? NewVersion { get; set; }
-
15
-
19 public bool? UploadZip { get; set; }
-
20 }
+
14 [RequestOptions(FieldPresence.Required)]
+
15 public Version? NewVersion { get; set; }
+
16
+
20 public bool? UploadZip { get; set; }
+
21 }
-
21}
+
22}
Tgstation.Server.Api.Models.Request.ServerUpdateRequest
Represents a request to update TGS.
Definition ServerUpdateRequest.cs:9
-
Tgstation.Server.Api.Models.Request.ServerUpdateRequest.NewVersion
Version? NewVersion
Changes the version of tgstation-server to the given version from the upstream repository.
Definition ServerUpdateRequest.cs:14
-
Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip
bool? UploadZip
If the user will provide the server update package .zip file via file transfer as opposed to TGS retr...
Definition ServerUpdateRequest.cs:19
+
Tgstation.Server.Api.Models.Request.ServerUpdateRequest.NewVersion
Version? NewVersion
Changes the version of tgstation-server to the given version from the upstream repository.
Definition ServerUpdateRequest.cs:15
+
Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip
bool? UploadZip
If the user will provide the server update package .zip file via file transfer as opposed to TGS retr...
Definition ServerUpdateRequest.cs:20
Tgstation.Server.Api.Models.Request
Definition ChatBotCreateRequest.cs:4
Tgstation.Server.Api.Models.FieldPresence
FieldPresence
Indicates whether a request field is Required or Ignored.
Definition FieldPresence.cs:7
diff --git a/_server_update_response_8cs_source.html b/_server_update_response_8cs_source.html index 46ef67e80a..e3f81185eb 100644 --- a/_server_update_response_8cs_source.html +++ b/_server_update_response_8cs_source.html @@ -91,24 +91,24 @@ $(document).ready(function() { init_codefold(0); });
10 public sealed class ServerUpdateResponse : FileTicketResponse
11 {
-
15 public Version NewVersion { get; }
-
16
-
22 [JsonConstructor]
-
-
23 public ServerUpdateResponse(Version newVersion, string? fileTicket)
-
24 {
-
25 NewVersion = newVersion ?? throw new ArgumentNullException(nameof(newVersion));
-
26 FileTicket = fileTicket;
-
27 }
+
16 public Version NewVersion { get; }
+
17
+
23 [JsonConstructor]
+
+
24 public ServerUpdateResponse(Version newVersion, string? fileTicket)
+
25 {
+
26 NewVersion = newVersion ?? throw new ArgumentNullException(nameof(newVersion));
+
27 FileTicket = fileTicket;
+
28 }
-
28 }
+
29 }
-
29}
+
30}
Response for when file transfers are necessary.
virtual ? string FileTicket
The ticket to use to access the Routes.Transfer controller.
A response to a Request.ServerUpdateRequest.
-
Version NewVersion
The version of tgstation-server pending update.
-
ServerUpdateResponse(Version newVersion, string? fileTicket)
Initializes a new instance of the ServerUpdateResponse class.
+
Version NewVersion
The version of tgstation-server pending update.
+
ServerUpdateResponse(Version newVersion, string? fileTicket)
Initializes a new instance of the ServerUpdateResponse class.
diff --git a/_session_controller_8cs_source.html b/_session_controller_8cs_source.html index 16410d01eb..f86d02d521 100644 --- a/_session_controller_8cs_source.html +++ b/_session_controller_8cs_source.html @@ -1146,7 +1146,7 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.CompileJob
Represents a deployment run.
Definition CompileJob.cs:11
-
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:41
+
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:43
Tgstation.Server.Host.Components.Chat.Commands.CustomCommand
Represents a command made from DM code.
Definition CustomCommand.cs:13
Tgstation.Server.Host.Components.Interop.Bridge.BridgeParameters
Parameters for a bridge request.
Definition BridgeParameters.cs:13
Tgstation.Server.Host.Components.Interop.Bridge.BridgeParameters.CommandType
BridgeCommandType? CommandType
The BridgeCommandType.
Definition BridgeParameters.cs:17
diff --git a/_session_controller_factory_8cs_source.html b/_session_controller_factory_8cs_source.html index 49d24280ef..34b9c1ac7f 100644 --- a/_session_controller_factory_8cs_source.html +++ b/_session_controller_factory_8cs_source.html @@ -641,17 +641,17 @@ $(document).ready(function() { init_codefold(0); });
666}
Exception
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
-
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:41
-
Tgstation.Server.Api.Models.Internal.CompileJob.MinimumSecurityLevel
DreamDaemonSecurity? MinimumSecurityLevel
The minimum DreamDaemonSecurity required to run the CompileJob's output.
Definition CompileJob.cs:34
+
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:43
+
Tgstation.Server.Api.Models.Internal.CompileJob.MinimumSecurityLevel
DreamDaemonSecurity? MinimumSecurityLevel
The minimum DreamDaemonSecurity required to run the CompileJob's output.
Definition CompileJob.cs:35
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters
Launch settings for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:10
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
Definition DreamDaemonLaunchParameters.cs:47
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:31
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput
bool? LogOutput
If process output/error text should be logged.
Definition DreamDaemonLaunchParameters.cs:99
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout
uint? TopicRequestTimeout
The timeout for sending and receiving BYOND topics in milliseconds.
Definition DreamDaemonLaunchParameters.cs:84
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:62
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:39
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
Definition DreamDaemonLaunchParameters.cs:51
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:33
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput
bool? LogOutput
If process output/error text should be logged.
Definition DreamDaemonLaunchParameters.cs:107
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout
uint? TopicRequestTimeout
The timeout for sending and receiving BYOND topics in milliseconds.
Definition DreamDaemonLaunchParameters.cs:92
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:68
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:42
Tgstation.Server.Host.Components.Interop.Bridge.RuntimeInformation
Representation of the initial data passed as part of a BridgeCommandType.Startup request.
Definition RuntimeInformation.cs:18
Tgstation.Server.Host.Components.Interop.DMApiConstants
Constants used for communication with the DMAPI.
Definition DMApiConstants.cs:16
Tgstation.Server.Host.Components.Interop.DMApiConstants.ParamServerPort
const string ParamServerPort
Identifies the Core.IServerPortProvider.HttpApiPort of the server.
Definition DMApiConstants.cs:25
diff --git a/_swagger_configuration_8cs_source.html b/_swagger_configuration_8cs_source.html index 8ef38f3458..043eadde9d 100644 --- a/_swagger_configuration_8cs_source.html +++ b/_swagger_configuration_8cs_source.html @@ -89,467 +89,467 @@ $(document).ready(function() { init_codefold(0); });
5using System.Net;
6using System.Net.Mime;
7using System.Reflection;
-
8
-
9using Microsoft.Extensions.DependencyInjection;
-
10using Microsoft.Net.Http.Headers;
-
11using Microsoft.OpenApi.Any;
-
12using Microsoft.OpenApi.Models;
-
13
-
14using Swashbuckle.AspNetCore.SwaggerGen;
-
15
-
16using Tgstation.Server.Api;
-
17using Tgstation.Server.Api.Models;
-
18using Tgstation.Server.Api.Models.Response;
-
19using Tgstation.Server.Common.Extensions;
-
20using Tgstation.Server.Host.Controllers;
-
21using Tgstation.Server.Host.Security;
-
22
-
23namespace Tgstation.Server.Host.Utils
-
24{
-
-
28 sealed class SwaggerConfiguration : IOperationFilter, IDocumentFilter, ISchemaFilter, IRequestBodyFilter
-
29 {
-
33 public const string DocumentName = "tgs_api";
-
34
-
38 public const string DocumentationSiteRouteExtension = "documentation";
-
39
-
43 const string PasswordSecuritySchemeId = "Password_Login_Scheme";
-
44
-
48 const string OAuthSecuritySchemeId = "OAuth_Login_Scheme";
-
49
-
53 const string TokenSecuritySchemeId = "Token_Authorization_Scheme";
-
54
-
-
61 public static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)
-
62 {
-
63 swaggerGenOptions.SwaggerDoc(
- -
65 new OpenApiInfo
-
66 {
-
67 Title = "TGS API",
-
68 Version = ApiHeaders.Version.Semver().ToString(),
-
69 License = new OpenApiLicense
-
70 {
-
71 Name = "AGPL-3.0",
-
72 Url = new Uri("https://github.com/tgstation/tgstation-server/blob/dev/LICENSE"),
-
73 },
-
74 Contact = new OpenApiContact
-
75 {
-
76 Name = "/tg/station 13",
-
77 Url = new Uri("https://github.com/tgstation"),
-
78 },
-
79 Description = "A production scale tool for DreamMaker server management",
-
80 });
-
81
-
82 // Important to do this before applying our own filters
-
83 // Otherwise we'll get NullReferenceExceptions on parameters to be setup in our document filter
-
84 swaggerGenOptions.IncludeXmlComments(assemblyDocumentationPath);
-
85 swaggerGenOptions.IncludeXmlComments(apiDocumentationPath);
-
86
-
87 // nullable stuff
-
88 swaggerGenOptions.UseAllOfToExtendReferenceSchemas();
-
89
-
90 swaggerGenOptions.OperationFilter<SwaggerConfiguration>();
-
91 swaggerGenOptions.DocumentFilter<SwaggerConfiguration>();
-
92 swaggerGenOptions.SchemaFilter<SwaggerConfiguration>();
-
93 swaggerGenOptions.RequestBodyFilter<SwaggerConfiguration>();
-
94
-
95 swaggerGenOptions.CustomSchemaIds(GenerateSchemaId);
-
96
-
97 swaggerGenOptions.AddSecurityDefinition(PasswordSecuritySchemeId, new OpenApiSecurityScheme
-
98 {
-
99 In = ParameterLocation.Header,
-
100 Type = SecuritySchemeType.Http,
-
101 Name = HeaderNames.Authorization,
- -
103 });
-
104
-
105 swaggerGenOptions.AddSecurityDefinition(OAuthSecuritySchemeId, new OpenApiSecurityScheme
-
106 {
-
107 In = ParameterLocation.Header,
-
108 Type = SecuritySchemeType.Http,
-
109 Name = HeaderNames.Authorization,
- -
111 });
-
112
-
113 swaggerGenOptions.AddSecurityDefinition(TokenSecuritySchemeId, new OpenApiSecurityScheme
-
114 {
-
115 BearerFormat = "JWT",
-
116 In = ParameterLocation.Header,
-
117 Type = SecuritySchemeType.Http,
-
118 Name = HeaderNames.Authorization,
- -
120 });
-
121 }
+
8using System.Text.RegularExpressions;
+
9
+
10using Microsoft.Extensions.DependencyInjection;
+
11using Microsoft.Net.Http.Headers;
+
12using Microsoft.OpenApi.Any;
+
13using Microsoft.OpenApi.Models;
+
14
+
15using Swashbuckle.AspNetCore.SwaggerGen;
+
16
+ + + + + + +
23
+ +
25{
+
+ +
30 {
+
34 public const string DocumentName = "tgs_api";
+
35
+
39 public const string DocumentationSiteRouteExtension = "documentation";
+
40
+
44 const string PasswordSecuritySchemeId = "Password_Login_Scheme";
+
45
+
49 const string OAuthSecuritySchemeId = "OAuth_Login_Scheme";
+
50
+
54 const string TokenSecuritySchemeId = "Token_Authorization_Scheme";
+
55
+
+
62 public static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)
+
63 {
+
64 swaggerGenOptions.SwaggerDoc(
+ +
66 new OpenApiInfo
+
67 {
+
68 Title = "TGS API",
+
69 Version = ApiHeaders.Version.Semver().ToString(),
+
70 License = new OpenApiLicense
+
71 {
+
72 Name = "AGPL-3.0",
+
73 Url = new Uri("https://github.com/tgstation/tgstation-server/blob/dev/LICENSE"),
+
74 },
+
75 Contact = new OpenApiContact
+
76 {
+
77 Name = "/tg/station 13",
+
78 Url = new Uri("https://github.com/tgstation"),
+
79 },
+
80 Description = "A production scale tool for DreamMaker server management",
+
81 });
+
82
+
83 // Important to do this before applying our own filters
+
84 // Otherwise we'll get NullReferenceExceptions on parameters to be setup in our document filter
+
85 swaggerGenOptions.IncludeXmlComments(assemblyDocumentationPath);
+
86 swaggerGenOptions.IncludeXmlComments(apiDocumentationPath);
+
87
+
88 // nullable stuff
+
89 swaggerGenOptions.UseAllOfToExtendReferenceSchemas();
+
90
+
91 swaggerGenOptions.OperationFilter<SwaggerConfiguration>();
+
92 swaggerGenOptions.DocumentFilter<SwaggerConfiguration>();
+
93 swaggerGenOptions.SchemaFilter<SwaggerConfiguration>();
+
94 swaggerGenOptions.RequestBodyFilter<SwaggerConfiguration>();
+
95
+
96 swaggerGenOptions.CustomSchemaIds(GenerateSchemaId);
+
97
+
98 swaggerGenOptions.AddSecurityDefinition(PasswordSecuritySchemeId, new OpenApiSecurityScheme
+
99 {
+
100 In = ParameterLocation.Header,
+
101 Type = SecuritySchemeType.Http,
+
102 Name = HeaderNames.Authorization,
+
103 Description = "Username & Password authentication to obtain an JWT token when doing a (POST /api).",
+ +
105 });
+
106
+
107 swaggerGenOptions.AddSecurityDefinition(OAuthSecuritySchemeId, new OpenApiSecurityScheme
+
108 {
+
109 In = ParameterLocation.Header,
+
110 Type = SecuritySchemeType.Http,
+
111 Name = HeaderNames.Authorization,
+
112 Description = "OAuth2 based authentication.",
+ +
114 });
+
115
+
116 swaggerGenOptions.AddSecurityDefinition(TokenSecuritySchemeId, new OpenApiSecurityScheme
+
117 {
+
118 In = ParameterLocation.Header,
+
119 Type = SecuritySchemeType.Http,
+
120 Name = HeaderNames.Authorization,
+
121 Description = "JWT Bearer token generated by the server (POST /api). You need this for most endpoints to work.",
+ +
123 BearerFormat = "JWT",
+
124 });
+
125 }
-
122
-
-
127 static void AddDefaultResponses(OpenApiDocument document)
-
128 {
-
129 var errorMessageContent = new Dictionary<string, OpenApiMediaType>
-
130 {
-
131 {
-
132 MediaTypeNames.Application.Json,
-
133 new OpenApiMediaType
-
134 {
-
135 Schema = new OpenApiSchema
-
136 {
-
137 Reference = new OpenApiReference
-
138 {
-
139 Id = nameof(ErrorMessageResponse),
-
140 Type = ReferenceType.Schema,
-
141 },
-
142 },
-
143 }
-
144 },
-
145 };
-
146
-
147 void AddDefaultResponse(HttpStatusCode code, OpenApiResponse concrete)
-
148 {
-
149 string responseKey = $"{(int)code}";
+
126
+
+
131 static void AddDefaultResponses(OpenApiDocument document)
+
132 {
+
133 var errorMessageContent = new Dictionary<string, OpenApiMediaType>
+
134 {
+
135 {
+
136 MediaTypeNames.Application.Json,
+
137 new OpenApiMediaType
+
138 {
+
139 Schema = new OpenApiSchema
+
140 {
+
141 Reference = new OpenApiReference
+
142 {
+
143 Id = nameof(ErrorMessageResponse),
+
144 Type = ReferenceType.Schema,
+
145 },
+
146 },
+
147 }
+
148 },
+
149 };
150
-
151 document.Components.Responses.Add(responseKey, concrete);
-
152
-
153 var referenceResponse = new OpenApiResponse
-
154 {
-
155 Reference = new OpenApiReference
-
156 {
-
157 Type = ReferenceType.Response,
-
158 Id = responseKey,
-
159 },
-
160 };
-
161
-
162 foreach (var operation in document.Paths.SelectMany(path => path.Value.Operations))
-
163 operation.Value.Responses.TryAdd(responseKey, referenceResponse);
-
164 }
+
151 void AddDefaultResponse(HttpStatusCode code, OpenApiResponse concrete)
+
152 {
+
153 string responseKey = $"{(int)code}";
+
154
+
155 document.Components.Responses.Add(responseKey, concrete);
+
156
+
157 var referenceResponse = new OpenApiResponse
+
158 {
+
159 Reference = new OpenApiReference
+
160 {
+
161 Type = ReferenceType.Response,
+
162 Id = responseKey,
+
163 },
+
164 };
165
-
166 AddDefaultResponse(HttpStatusCode.BadRequest, new OpenApiResponse
-
167 {
-
168 Description = "A badly formatted request was made. See error message for details.",
-
169 Content = errorMessageContent,
-
170 });
-
171
-
172 AddDefaultResponse(HttpStatusCode.Unauthorized, new OpenApiResponse
-
173 {
-
174 Description = "Invalid Authentication header.",
-
175 });
-
176
-
177 AddDefaultResponse(HttpStatusCode.Forbidden, new OpenApiResponse
-
178 {
-
179 Description = "User lacks sufficient permissions for the operation.",
-
180 });
-
181
-
182 AddDefaultResponse(HttpStatusCode.Conflict, new OpenApiResponse
-
183 {
-
184 Description = "A data integrity check failed while performing the operation. See error message for details.",
-
185 Content = errorMessageContent,
-
186 });
-
187
-
188 AddDefaultResponse(HttpStatusCode.NotAcceptable, new OpenApiResponse
-
189 {
-
190 Description = $"Invalid Accept header, TGS requires `{HeaderNames.Accept}: {MediaTypeNames.Application.Json}`.",
-
191 Content = errorMessageContent,
-
192 });
-
193
-
194 AddDefaultResponse(HttpStatusCode.InternalServerError, new OpenApiResponse
-
195 {
-
196 Description = ErrorCode.InternalServerError.Describe(),
-
197 Content = errorMessageContent,
-
198 });
-
199
-
200 AddDefaultResponse(HttpStatusCode.ServiceUnavailable, new OpenApiResponse
-
201 {
-
202 Description = "The server may be starting up or shutting down.",
-
203 });
-
204
-
205 AddDefaultResponse(HttpStatusCode.NotImplemented, new OpenApiResponse
-
206 {
-
207 Description = ErrorCode.RequiresPosixSystemIdentity.Describe(),
-
208 Content = errorMessageContent,
-
209 });
-
210 }
+
166 foreach (var operation in document.Paths.SelectMany(path => path.Value.Operations))
+
167 operation.Value.Responses.TryAdd(responseKey, referenceResponse);
+
168 }
+
169
+
170 AddDefaultResponse(HttpStatusCode.BadRequest, new OpenApiResponse
+
171 {
+
172 Description = "A badly formatted request was made. See error message for details.",
+
173 Content = errorMessageContent,
+
174 });
+
175
+
176 AddDefaultResponse(HttpStatusCode.Unauthorized, new OpenApiResponse
+
177 {
+
178 Description = "Invalid Authentication header.",
+
179 });
+
180
+
181 AddDefaultResponse(HttpStatusCode.Forbidden, new OpenApiResponse
+
182 {
+
183 Description = "User lacks sufficient permissions for the operation.",
+
184 });
+
185
+
186 AddDefaultResponse(HttpStatusCode.Conflict, new OpenApiResponse
+
187 {
+
188 Description = "A data integrity check failed while performing the operation. See error message for details.",
+
189 Content = errorMessageContent,
+
190 });
+
191
+
192 AddDefaultResponse(HttpStatusCode.NotAcceptable, new OpenApiResponse
+
193 {
+
194 Description = $"Invalid Accept header, TGS requires `{HeaderNames.Accept}: {MediaTypeNames.Application.Json}`.",
+
195 Content = errorMessageContent,
+
196 });
+
197
+
198 AddDefaultResponse(HttpStatusCode.InternalServerError, new OpenApiResponse
+
199 {
+
200 Description = ErrorCode.InternalServerError.Describe(),
+
201 Content = errorMessageContent,
+
202 });
+
203
+
204 AddDefaultResponse(HttpStatusCode.ServiceUnavailable, new OpenApiResponse
+
205 {
+
206 Description = "The server may be starting up or shutting down.",
+
207 });
+
208
+
209 AddDefaultResponse(HttpStatusCode.NotImplemented, new OpenApiResponse
+
210 {
+
211 Description = ErrorCode.RequiresPosixSystemIdentity.Describe(),
+
212 Content = errorMessageContent,
+
213 });
+
214 }
-
211
-
-
217 static void ApplyAttributesForRootSchema(OpenApiSchema rootSchema, SchemaFilterContext context)
-
218 {
-
219 // tune up the descendants
-
220 rootSchema.Nullable = false;
-
221 var rootSchemaId = GenerateSchemaId(context.Type);
-
222 var rootRequestSchema = rootSchemaId.EndsWith("Request", StringComparison.Ordinal);
-
223 var rootResponseSchema = rootSchemaId.EndsWith("Response", StringComparison.Ordinal);
-
224 var isPutRequest = rootSchemaId.EndsWith("CreateRequest", StringComparison.Ordinal);
-
225
-
226 Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>> GetTypeFromKvp(Type currentType, KeyValuePair<string, OpenApiSchema> kvp, IDictionary<string, OpenApiSchema> schemaDictionary)
-
227 {
-
228 var propertyInfo = currentType
-
229 .GetProperties()
-
230 .Single(x => x.Name.Equals(kvp.Key, StringComparison.OrdinalIgnoreCase));
-
231
-
232 return Tuple.Create(
-
233 propertyInfo,
-
234 kvp.Key,
-
235 kvp.Value,
-
236 schemaDictionary);
-
237 }
-
238
-
239 var subSchemaStack = new Stack<Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>>>(
-
240 rootSchema
-
241 .Properties
-
242 .Select(
-
243 x => GetTypeFromKvp(context.Type, x, rootSchema.Properties))
-
244 .Where(x => x.Item3.Reference == null));
-
245
-
246 while (subSchemaStack.Count > 0)
-
247 {
-
248 var tuple = subSchemaStack.Pop();
-
249 var subSchema = tuple.Item3;
-
250
-
251 var subSchemaPropertyInfo = tuple.Item1;
-
252
-
253 if (subSchema.Properties != null
-
254 && !subSchemaPropertyInfo
-
255 .PropertyType
-
256 .GetInterfaces()
-
257 .Any(x => x == typeof(IEnumerable)))
-
258 foreach (var kvp in subSchema.Properties.Where(x => x.Value.Reference == null))
-
259 subSchemaStack.Push(GetTypeFromKvp(subSchemaPropertyInfo.PropertyType, kvp, subSchema.Properties));
-
260
-
261 var attributes = subSchemaPropertyInfo
-
262 .GetCustomAttributes();
-
263 var responsePresence = attributes
-
264 .OfType<ResponseOptionsAttribute>()
-
265 .FirstOrDefault()
-
266 ?.Presence
-
267 ?? FieldPresence.Required;
-
268 var requestOptions = attributes
-
269 .OfType<RequestOptionsAttribute>()
-
270 .OrderBy(x => x.PutOnly) // Process PUTs last
-
271 .ToList();
-
272
-
273 if (requestOptions.Count == 0 && requestOptions.All(x => x.Presence == FieldPresence.Ignored && !x.PutOnly))
-
274 subSchema.ReadOnly = true;
-
275
-
276 var subSchemaId = tuple.Item2;
-
277 var subSchemaOwningDictionary = tuple.Item4;
-
278 if (rootResponseSchema)
-
279 {
-
280 subSchema.Nullable = responsePresence == FieldPresence.Optional;
-
281 if (responsePresence == FieldPresence.Ignored)
-
282 subSchemaOwningDictionary.Remove(subSchemaId);
-
283 }
-
284 else if (rootRequestSchema)
-
285 {
-
286 subSchema.Nullable = true;
-
287 var lastOptionWasIgnored = false;
-
288 foreach (var requestOption in requestOptions)
-
289 {
-
290 var validForThisRequest = !requestOption.PutOnly || isPutRequest;
-
291 if (!validForThisRequest)
-
292 continue;
-
293
-
294 lastOptionWasIgnored = false;
-
295 switch (requestOption.Presence)
-
296 {
-
297 case FieldPresence.Ignored:
-
298 lastOptionWasIgnored = true;
-
299 break;
-
300 case FieldPresence.Optional:
-
301 subSchema.Nullable = true;
-
302 break;
-
303 case FieldPresence.Required:
-
304 subSchema.Nullable = false;
-
305 break;
-
306 default:
-
307 throw new InvalidOperationException($"Invalid FieldPresence: {requestOption.Presence}!");
-
308 }
-
309 }
-
310
-
311 if (lastOptionWasIgnored)
-
312 subSchemaOwningDictionary.Remove(subSchemaId);
-
313 }
-
314 else if (responsePresence == FieldPresence.Required
-
315 && requestOptions.All(x => x.Presence == FieldPresence.Required && !x.PutOnly))
-
316 subSchema.Nullable = subSchemaId.Equals(
- -
318 StringComparison.OrdinalIgnoreCase)
-
319 && rootSchemaId == nameof(TestMergeParameters); // special tactics
-
320
-
321 // otherwise, we have to assume it's a shared schema
-
322 // use what Swagger thinks the nullability is by default
-
323 }
-
324 }
+
215
+
+
221 static void ApplyAttributesForRootSchema(OpenApiSchema rootSchema, SchemaFilterContext context)
+
222 {
+
223 // tune up the descendants
+
224 rootSchema.Nullable = false;
+
225 var rootSchemaId = GenerateSchemaId(context.Type);
+
226 var rootRequestSchema = rootSchemaId.EndsWith("Request", StringComparison.Ordinal);
+
227 var rootResponseSchema = rootSchemaId.EndsWith("Response", StringComparison.Ordinal);
+
228 var isPutRequest = rootSchemaId.EndsWith("CreateRequest", StringComparison.Ordinal);
+
229
+
230 Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>> GetTypeFromKvp(Type currentType, KeyValuePair<string, OpenApiSchema> kvp, IDictionary<string, OpenApiSchema> schemaDictionary)
+
231 {
+
232 var propertyInfo = currentType
+
233 .GetProperties()
+
234 .Single(x => x.Name.Equals(kvp.Key, StringComparison.OrdinalIgnoreCase));
+
235
+
236 return Tuple.Create(
+
237 propertyInfo,
+
238 kvp.Key,
+
239 kvp.Value,
+
240 schemaDictionary);
+
241 }
+
242
+
243 var subSchemaStack = new Stack<Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>>>(
+
244 rootSchema
+
245 .Properties
+
246 .Select(
+
247 x => GetTypeFromKvp(context.Type, x, rootSchema.Properties))
+
248 .Where(x => x.Item3.Reference == null));
+
249
+
250 while (subSchemaStack.Count > 0)
+
251 {
+
252 var tuple = subSchemaStack.Pop();
+
253 var subSchema = tuple.Item3;
+
254
+
255 var subSchemaPropertyInfo = tuple.Item1;
+
256
+
257 if (subSchema.Properties != null
+
258 && !subSchemaPropertyInfo
+
259 .PropertyType
+
260 .GetInterfaces()
+
261 .Any(x => x == typeof(IEnumerable)))
+
262 foreach (var kvp in subSchema.Properties.Where(x => x.Value.Reference == null))
+
263 subSchemaStack.Push(GetTypeFromKvp(subSchemaPropertyInfo.PropertyType, kvp, subSchema.Properties));
+
264
+
265 var attributes = subSchemaPropertyInfo
+
266 .GetCustomAttributes();
+
267 var responsePresence = attributes
+
268 .OfType<ResponseOptionsAttribute>()
+
269 .FirstOrDefault()
+
270 ?.Presence
+
271 ?? FieldPresence.Required;
+
272 var requestOptions = attributes
+
273 .OfType<RequestOptionsAttribute>()
+
274 .OrderBy(x => x.PutOnly) // Process PUTs last
+
275 .ToList();
+
276
+
277 if (requestOptions.Count == 0 && requestOptions.All(x => x.Presence == FieldPresence.Ignored && !x.PutOnly))
+
278 subSchema.ReadOnly = true;
+
279
+
280 var subSchemaId = tuple.Item2;
+
281 var subSchemaOwningDictionary = tuple.Item4;
+
282 if (rootResponseSchema)
+
283 {
+
284 subSchema.Nullable = responsePresence == FieldPresence.Optional;
+
285 if (responsePresence == FieldPresence.Ignored)
+
286 subSchemaOwningDictionary.Remove(subSchemaId);
+
287 }
+
288 else if (rootRequestSchema)
+
289 {
+
290 subSchema.Nullable = true;
+
291 var lastOptionWasIgnored = false;
+
292 foreach (var requestOption in requestOptions)
+
293 {
+
294 var validForThisRequest = !requestOption.PutOnly || isPutRequest;
+
295 if (!validForThisRequest)
+
296 continue;
+
297
+
298 lastOptionWasIgnored = false;
+
299 switch (requestOption.Presence)
+
300 {
+
301 case FieldPresence.Ignored:
+
302 lastOptionWasIgnored = true;
+
303 break;
+
304 case FieldPresence.Optional:
+
305 subSchema.Nullable = true;
+
306 break;
+
307 case FieldPresence.Required:
+
308 subSchema.Nullable = false;
+
309 break;
+
310 default:
+
311 throw new InvalidOperationException($"Invalid FieldPresence: {requestOption.Presence}!");
+
312 }
+
313 }
+
314
+
315 if (lastOptionWasIgnored)
+
316 subSchemaOwningDictionary.Remove(subSchemaId);
+
317 }
+
318 else if (responsePresence == FieldPresence.Required
+
319 && requestOptions.All(x => x.Presence == FieldPresence.Required && !x.PutOnly))
+
320 subSchema.Nullable = subSchemaId.Equals(
+ +
322 StringComparison.OrdinalIgnoreCase)
+
323 && rootSchemaId == nameof(TestMergeParameters); // special tactics
+
324
+
325 // otherwise, we have to assume it's a shared schema
+
326 // use what Swagger thinks the nullability is by default
+
327 }
+
328 }
-
325
-
-
331 static string GenerateSchemaId(Type type)
-
332 {
-
333 if (type == typeof(UserName))
-
334 return "ShallowUserResponse";
-
335
-
336 if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(PaginatedResponse<>))
-
337 return $"Paginated{type.GenericTypeArguments.First().Name}";
-
338
-
339 return type.Name;
-
340 }
+
329
+
+
335 static string GenerateSchemaId(Type type)
+
336 {
+
337 if (type == typeof(UserName))
+
338 return "ShallowUserResponse";
+
339
+
340 if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(PaginatedResponse<>))
+
341 return $"Paginated{type.GenericTypeArguments.First().Name}";
+
342
+
343 return type.Name;
+
344 }
-
341
-
-
343 public void Apply(OpenApiOperation operation, OperationFilterContext context)
-
344 {
-
345 ArgumentNullException.ThrowIfNull(operation);
-
346 ArgumentNullException.ThrowIfNull(context);
-
347
-
348 operation.OperationId = $"{context.MethodInfo.DeclaringType!.Name}.{context.MethodInfo.Name}";
-
349
-
350 var authAttributes = context
-
351 .MethodInfo
-
352 .DeclaringType
-
353 .GetCustomAttributes(true)
-
354 .Union(
-
355 context
-
356 .MethodInfo
-
357 .GetCustomAttributes(true))
-
358 .OfType<TgsAuthorizeAttribute>();
-
359
-
360 if (authAttributes.Any())
-
361 {
-
362 var tokenScheme = new OpenApiSecurityScheme
-
363 {
-
364 Reference = new OpenApiReference
-
365 {
-
366 Type = ReferenceType.SecurityScheme,
- -
368 },
-
369 };
-
370
-
371 operation.Security = new List<OpenApiSecurityRequirement>
-
372 {
-
373 new()
-
374 {
-
375 {
-
376 tokenScheme,
-
377 new List<string>()
-
378 },
-
379 },
-
380 };
-
381
-
382 if (typeof(InstanceRequiredController).IsAssignableFrom(context.MethodInfo.DeclaringType))
-
383 operation.Parameters.Insert(0, new OpenApiParameter
-
384 {
-
385 Reference = new OpenApiReference
-
386 {
-
387 Type = ReferenceType.Parameter,
- -
389 },
-
390 });
-
391 else if (typeof(TransferController).IsAssignableFrom(context.MethodInfo.DeclaringType))
-
392 if (context.MethodInfo.Name == nameof(TransferController.Upload))
-
393 operation.RequestBody = new OpenApiRequestBody
-
394 {
-
395 Content = new Dictionary<string, OpenApiMediaType>
-
396 {
-
397 {
-
398 MediaTypeNames.Application.Octet,
-
399 new OpenApiMediaType
-
400 {
-
401 Schema = new OpenApiSchema
-
402 {
-
403 Type = "string",
-
404 Format = "binary",
-
405 },
-
406 }
-
407 },
-
408 },
-
409 };
-
410 else if (context.MethodInfo.Name == nameof(TransferController.Download))
-
411 {
-
412 var twoHundredResponseContents = operation.Responses["200"].Content;
-
413 var fileContent = twoHundredResponseContents[MediaTypeNames.Application.Json];
-
414 twoHundredResponseContents.Remove(MediaTypeNames.Application.Json);
-
415 twoHundredResponseContents.Add(MediaTypeNames.Application.Octet, fileContent);
-
416 }
-
417 }
-
418 else if (context.MethodInfo.Name == nameof(ApiRootController.CreateToken))
-
419 {
-
420 var passwordScheme = new OpenApiSecurityScheme
-
421 {
-
422 Reference = new OpenApiReference
-
423 {
-
424 Type = ReferenceType.SecurityScheme,
- -
426 },
-
427 };
-
428
-
429 var oAuthScheme = new OpenApiSecurityScheme
-
430 {
-
431 Reference = new OpenApiReference
-
432 {
-
433 Type = ReferenceType.SecurityScheme,
- -
435 },
-
436 };
-
437
-
438 operation.Parameters.Add(new OpenApiParameter
-
439 {
-
440 In = ParameterLocation.Header,
- -
442 Description = "The external OAuth service provider.",
-
443 Style = ParameterStyle.Simple,
-
444 Example = new OpenApiString("Discord"),
-
445 Schema = new OpenApiSchema
-
446 {
-
447 Type = "string",
-
448 },
-
449 });
-
450
-
451 operation.Security = new List<OpenApiSecurityRequirement>
-
452 {
-
453 new()
-
454 {
-
455 {
-
456 passwordScheme,
-
457 new List<string>()
-
458 },
-
459 {
-
460 oAuthScheme,
-
461 new List<string>()
-
462 },
-
463 },
-
464 };
-
465 }
-
466 }
+
345
+
+
347 public void Apply(OpenApiOperation operation, OperationFilterContext context)
+
348 {
+
349 ArgumentNullException.ThrowIfNull(operation);
+
350 ArgumentNullException.ThrowIfNull(context);
+
351
+
352 operation.OperationId = $"{context.MethodInfo.DeclaringType!.Name}.{context.MethodInfo.Name}";
+
353
+
354 var authAttributes = context
+
355 .MethodInfo
+
356 .DeclaringType
+
357 .GetCustomAttributes(true)
+
358 .Union(
+
359 context
+
360 .MethodInfo
+
361 .GetCustomAttributes(true))
+
362 .OfType<TgsAuthorizeAttribute>();
+
363
+
364 if (authAttributes.Any())
+
365 {
+
366 var tokenScheme = new OpenApiSecurityScheme
+
367 {
+
368 Reference = new OpenApiReference
+
369 {
+
370 Type = ReferenceType.SecurityScheme,
+ +
372 },
+
373 };
+
374
+
375 operation.Security = new List<OpenApiSecurityRequirement>()
+
376 {
+
377 new()
+
378 {
+
379 { tokenScheme, new List<string>() },
+
380 },
+
381 };
+
382
+
383 if (typeof(InstanceRequiredController).IsAssignableFrom(context.MethodInfo.DeclaringType))
+
384 operation.Parameters.Insert(0, new OpenApiParameter
+
385 {
+
386 Reference = new OpenApiReference
+
387 {
+
388 Type = ReferenceType.Parameter,
+ +
390 },
+
391 });
+
392 else if (typeof(TransferController).IsAssignableFrom(context.MethodInfo.DeclaringType))
+
393 if (context.MethodInfo.Name == nameof(TransferController.Upload))
+
394 operation.RequestBody = new OpenApiRequestBody
+
395 {
+
396 Content = new Dictionary<string, OpenApiMediaType>
+
397 {
+
398 {
+
399 MediaTypeNames.Application.Octet,
+
400 new OpenApiMediaType
+
401 {
+
402 Schema = new OpenApiSchema
+
403 {
+
404 Type = "string",
+
405 Format = "binary",
+
406 },
+
407 }
+
408 },
+
409 },
+
410 };
+
411 else if (context.MethodInfo.Name == nameof(TransferController.Download))
+
412 {
+
413 var twoHundredResponseContents = operation.Responses["200"].Content;
+
414 var fileContent = twoHundredResponseContents[MediaTypeNames.Application.Json];
+
415 twoHundredResponseContents.Remove(MediaTypeNames.Application.Json);
+
416 twoHundredResponseContents.Add(MediaTypeNames.Application.Octet, fileContent);
+
417 }
+
418 }
+
419 else if (context.MethodInfo.Name == nameof(ApiRootController.CreateToken))
+
420 {
+
421 var passwordScheme = new OpenApiSecurityScheme
+
422 {
+
423 Reference = new OpenApiReference
+
424 {
+
425 Type = ReferenceType.SecurityScheme,
+ +
427 },
+
428 };
+
429
+
430 var oAuthScheme = new OpenApiSecurityScheme
+
431 {
+
432 Reference = new OpenApiReference
+
433 {
+
434 Type = ReferenceType.SecurityScheme,
+ +
436 },
+
437 };
+
438
+
439 operation.Parameters.Add(new OpenApiParameter
+
440 {
+
441 In = ParameterLocation.Header,
+ +
443 Description = "The external OAuth service provider.",
+
444 Style = ParameterStyle.Simple,
+
445 Example = new OpenApiString("Discord"),
+
446 Schema = new OpenApiSchema
+
447 {
+
448 Type = "string",
+
449 },
+
450 });
+
451
+
452 operation.Security = new List<OpenApiSecurityRequirement>
+
453 {
+
454 new()
+
455 {
+
456 {
+
457 passwordScheme,
+
458 new List<string>()
+
459 },
+
460 {
+
461 oAuthScheme,
+
462 new List<string>()
+
463 },
+
464 },
+
465 };
+
466 }
+
467 }
-
467
-
-
469 public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
-
470 {
-
471 ArgumentNullException.ThrowIfNull(swaggerDoc);
-
472 ArgumentNullException.ThrowIfNull(context);
-
473
-
474 swaggerDoc.ExternalDocs = new OpenApiExternalDocs
-
475 {
-
476 Description = "API Usage Documentation",
-
477 Url = new Uri("https://tgstation.github.io/tgstation-server/api.html"),
-
478 };
-
479
-
480 swaggerDoc.Components.Parameters.Add(ApiHeaders.InstanceIdHeader, new OpenApiParameter
-
481 {
-
482 In = ParameterLocation.Header,
-
483 Name = ApiHeaders.InstanceIdHeader,
-
484 Description = "The instance ID being accessed",
-
485 Required = true,
-
486 Style = ParameterStyle.Simple,
-
487 Schema = new OpenApiSchema
-
488 {
-
489 Type = "integer",
-
490 },
-
491 });
-
492
-
493 var productHeaderSchema = new OpenApiSchema
-
494 {
-
495 Type = "string",
-
496 Format = "productheader",
+
468
+
+
470 public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
+
471 {
+
472 ArgumentNullException.ThrowIfNull(swaggerDoc);
+
473 ArgumentNullException.ThrowIfNull(context);
+
474
+
475 swaggerDoc.ExternalDocs = new OpenApiExternalDocs
+
476 {
+
477 Description = "API Usage Documentation",
+
478 Url = new Uri("https://tgstation.github.io/tgstation-server/api.html"),
+
479 };
+
480
+
481 swaggerDoc.Components.Parameters.Add(ApiHeaders.InstanceIdHeader, new OpenApiParameter
+
482 {
+
483 In = ParameterLocation.Header,
+
484 Name = ApiHeaders.InstanceIdHeader,
+
485 Description = "The instance ID being accessed",
+
486 Required = true,
+
487 Style = ParameterStyle.Simple,
+
488 Schema = new OpenApiSchema
+
489 {
+
490 Type = "integer",
+
491 },
+
492 });
+
493
+
494 var productHeaderSchema = new OpenApiSchema
+
495 {
+
496 Type = "string",
497 };
498
499 swaggerDoc.Components.Parameters.Add(ApiHeaders.ApiVersionHeader, new OpenApiParameter
@@ -597,48 +597,70 @@ $(document).ready(function() { init_codefold(0); });
541 Id = HeaderNames.UserAgent,
542 },
543 });
-
544 }
-
545
-
546 AddDefaultResponses(swaggerDoc);
-
547 }
-
+
544
+
545 // flatten (Tgstation.Server.*).MyClass
+
546 if (operation.Description?.Length > 0)
+
547 operation.Description = Regex.Replace(operation.Description, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
548
-
-
550 public void Apply(OpenApiSchema schema, SchemaFilterContext context)
-
551 {
-
552 ArgumentNullException.ThrowIfNull(schema);
-
553 ArgumentNullException.ThrowIfNull(context);
+
549 if (operation.Summary?.Length > 0)
+
550 operation.Summary = Regex.Replace(operation.Summary, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
+
551
+
552 if (operation.RequestBody?.Description != null)
+
553 operation.RequestBody.Description = Regex.Replace(operation.RequestBody.Description, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
554
-
555 // Nothing is required
-
556 schema.Required.Clear();
-
557
-
558 if (context.MemberInfo == null)
-
559 ApplyAttributesForRootSchema(schema, context);
+
555 foreach (var opPar in operation.Parameters)
+
556 {
+
557 if (opPar.Description != null)
+
558 opPar.Description = Regex.Replace(opPar.Description, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
+
559 }
560
-
561 if (!schema.Enum?.Any() ?? false)
-
562 return;
-
563
-
564 // Could be nullable type, make sure to get the right one
-
565 Type firstGenericArgumentOrType = context.Type.IsConstructedGenericType
-
566 ? context.Type.GenericTypeArguments.First()
-
567 : context.Type;
-
568
-
569 OpenApiEnumVarNamesExtension.Apply(schema, firstGenericArgumentOrType);
-
570 }
+
561 foreach (var (_, opRes) in operation.Responses)
+
562 {
+
563 if (opRes.Description != null)
+
564 opRes.Description = Regex.Replace(opRes.Description, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
+
565 }
+
566 }
+
567
+
568 AddDefaultResponses(swaggerDoc);
+
569 }
-
571
-
-
573 public void Apply(OpenApiRequestBody requestBody, RequestBodyFilterContext context)
-
574 {
-
575 ArgumentNullException.ThrowIfNull(requestBody);
-
576 ArgumentNullException.ThrowIfNull(context);
-
577
-
578 requestBody.Required = true;
-
579 }
+
570
+
+
572 public void Apply(OpenApiSchema schema, SchemaFilterContext context)
+
573 {
+
574 ArgumentNullException.ThrowIfNull(schema);
+
575 ArgumentNullException.ThrowIfNull(context);
+
576
+
577 // Nothing is required
+
578 schema.Required.Clear();
+
579
+
580 if (context.MemberInfo == null)
+
581 ApplyAttributesForRootSchema(schema, context);
+
582
+
583 if (!schema.Enum?.Any() ?? false)
+
584 return;
+
585
+
586 // Could be nullable type, make sure to get the right one
+
587 Type firstGenericArgumentOrType = context.Type.IsConstructedGenericType
+
588 ? context.Type.GenericTypeArguments.First()
+
589 : context.Type;
+
590
+
591 OpenApiEnumVarNamesExtension.Apply(schema, firstGenericArgumentOrType);
+
592 }
-
580 }
+
593
+
+
595 public void Apply(OpenApiRequestBody requestBody, RequestBodyFilterContext context)
+
596 {
+
597 ArgumentNullException.ThrowIfNull(requestBody);
+
598 ArgumentNullException.ThrowIfNull(context);
+
599
+
600 requestBody.Required = true;
+
601 }
-
581}
+
602 }
+
+
603}
@@ -657,7 +679,7 @@ $(document).ready(function() { init_codefold(0); });
Indicates the response FieldPresence of API fields. Changes it from FieldPresence....
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
Base class for user names.
Definition UserName.cs:7
Root ApiController for the Application.
ValueTask< IActionResult > CreateToken(CancellationToken cancellationToken)
Attempt to authenticate a User using ApiController.ApiHeaders.
@@ -668,20 +690,20 @@ $(document).ready(function() { init_codefold(0); });
Helper for using the AuthorizeAttribute with the Api.Rights system.
Implements the "x-enum-varnames" OpenAPI 3.0 extension.
static void Apply(OpenApiSchema openApiSchema, Type enumType)
Applies the extension to a give openApiSchema .
-
Implements various filters for Swashbuckle.
-
static string GenerateSchemaId(Type type)
Generates the OpenAPI schema ID for a given type .
-
void Apply(OpenApiRequestBody requestBody, RequestBodyFilterContext context)
-
const string OAuthSecuritySchemeId
The OpenApiSecurityScheme name for OAuth 2.0 authentication.
-
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
-
void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
-
void Apply(OpenApiSchema schema, SchemaFilterContext context)
-
static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)
Configure the swagger settings.
-
const string PasswordSecuritySchemeId
The OpenApiSecurityScheme name for password authentication.
-
const string TokenSecuritySchemeId
The OpenApiSecurityScheme name for token authentication.
-
const string DocumentName
The name of the swagger document.
-
static void AddDefaultResponses(OpenApiDocument document)
Add the default error responses to a given document .
-
void Apply(OpenApiOperation operation, OperationFilterContext context)
-
static void ApplyAttributesForRootSchema(OpenApiSchema rootSchema, SchemaFilterContext context)
Applies the OpenApiSchema.Nullable, OpenApiSchema.ReadOnly, and OpenApiSchema.WriteOnly to OpenApiSch...
+
Implements various filters for Swashbuckle.
+
static string GenerateSchemaId(Type type)
Generates the OpenAPI schema ID for a given type .
+
void Apply(OpenApiRequestBody requestBody, RequestBodyFilterContext context)
+
const string OAuthSecuritySchemeId
The OpenApiSecurityScheme name for OAuth 2.0 authentication.
+
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
+
void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
+
void Apply(OpenApiSchema schema, SchemaFilterContext context)
+
static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)
Configure the swagger settings.
+
const string PasswordSecuritySchemeId
The OpenApiSecurityScheme name for password authentication.
+
const string TokenSecuritySchemeId
The OpenApiSecurityScheme name for token authentication.
+
const string DocumentName
The name of the swagger document.
+
static void AddDefaultResponses(OpenApiDocument document)
Add the default error responses to a given document .
+
void Apply(OpenApiOperation operation, OperationFilterContext context)
+
static void ApplyAttributesForRootSchema(OpenApiSchema rootSchema, SchemaFilterContext context)
Applies the OpenApiSchema.Nullable, OpenApiSchema.ReadOnly, and OpenApiSchema.WriteOnly to OpenApiSch...
FieldPresence
Indicates whether a request field is Required or Ignored.
diff --git a/_swarm_node_8cs_source.html b/_swarm_node_8cs_source.html index 75500330d4..9b4c038052 100644 --- a/_swarm_node_8cs_source.html +++ b/_swarm_node_8cs_source.html @@ -165,9 +165,9 @@ $(document).ready(function() { init_codefold(0); });
virtual ? Uri PublicAddress
The address the swarm server can be publically accessed.
virtual ? Uri Address
The public address of the server.
-
string? Identifier
The server's identifier.
+
string? Identifier
The server's identifier.
Represents information about a running SwarmServer.
-
bool Controller
If the SwarmServerResponse is the controller.
+
bool Controller
If the SwarmServerResponse is the controller.
Exception representing ErrorMessageResponses.
IGateway for the SwarmNode this query is executing on.
Represents a node server in a swarm.
Definition SwarmNode.cs:23
diff --git a/_swarm_server_8cs_source.html b/_swarm_server_8cs_source.html index 0da801f40e..1d84ed1c2b 100644 --- a/_swarm_server_8cs_source.html +++ b/_swarm_server_8cs_source.html @@ -95,37 +95,37 @@ $(document).ready(function() { init_codefold(0); });
16
20 public virtual Uri? PublicAddress { get; set; }
21
-
25 [Required]
-
26 public string? Identifier { get; set; }
-
27
-
-
31 protected SwarmServer()
-
32 {
-
33 }
+
26 [Required]
+
27 public string? Identifier { get; set; }
+
28
+
+
32 protected SwarmServer()
+
33 {
+
34 }
-
34
-
-
39 protected SwarmServer(SwarmServer copy)
-
40 {
-
41 if (copy == null)
-
42 {
-
43 throw new ArgumentNullException(nameof(copy));
-
44 }
-
45
-
46 Address = copy.Address;
- - -
49 }
+
35
+
+
40 protected SwarmServer(SwarmServer copy)
+
41 {
+
42 if (copy == null)
+
43 {
+
44 throw new ArgumentNullException(nameof(copy));
+
45 }
+
46
+
47 Address = copy.Address;
+ + +
50 }
-
50 }
+
51 }
-
51}
+
52}
Information about a server in the swarm.
virtual ? Uri PublicAddress
The address the swarm server can be publically accessed.
-
SwarmServer()
Initializes a new instance of the SwarmServer class.
+
SwarmServer()
Initializes a new instance of the SwarmServer class.
virtual ? Uri Address
The public address of the server.
-
SwarmServer(SwarmServer copy)
Initializes a new instance of the SwarmServer class.
-
string? Identifier
The server's identifier.
+
SwarmServer(SwarmServer copy)
Initializes a new instance of the SwarmServer class.
+
string? Identifier
The server's identifier.
@ Required
DMAPI validation must suceed for the deployment to succeed.
diff --git a/_swarm_server_information_8cs_source.html b/_swarm_server_information_8cs_source.html index 2c1cd56040..6cfb37dd65 100644 --- a/_swarm_server_information_8cs_source.html +++ b/_swarm_server_information_8cs_source.html @@ -89,30 +89,30 @@ $(document).ready(function() { init_codefold(0); });
9 {
-
13 public bool Controller { get; set; }
-
14
-
- -
19 {
-
20 }
+
14 public bool Controller { get; set; }
+
15
+
+ +
20 {
+
21 }
-
21
-
- -
27 : base(copy)
-
28 {
- -
30 }
+
22
+
+ +
28 : base(copy)
+
29 {
+ +
31 }
-
31 }
+
32 }
-
32}
+
33}
Information about a server in the swarm.
Represents information about a running SwarmServer.
-
bool Controller
If the SwarmServerResponse is the controller.
-
SwarmServerInformation()
Initializes a new instance of the SwarmServerInformation class.
-
SwarmServerInformation(SwarmServerInformation copy)
Initializes a new instance of the SwarmServerInformation class.
+
bool Controller
If the SwarmServerResponse is the controller.
+
SwarmServerInformation()
Initializes a new instance of the SwarmServerInformation class.
+
SwarmServerInformation(SwarmServerInformation copy)
Initializes a new instance of the SwarmServerInformation class.
diff --git a/_swarm_service_8cs_source.html b/_swarm_service_8cs_source.html index 5b53e425c4..52a318d749 100644 --- a/_swarm_service_8cs_source.html +++ b/_swarm_service_8cs_source.html @@ -1567,7 +1567,7 @@ $(document).ready(function() { init_codefold(0); });
Information about a server in the swarm.
virtual ? Uri PublicAddress
The address the swarm server can be publically accessed.
virtual ? Uri Address
The public address of the server.
-
string? Identifier
The server's identifier.
+
string? Identifier
The server's identifier.
Represents information about a running SwarmServer.
Response for when file transfers are necessary.
Extension methods for the ValueTask and ValueTask<TResult> classes.
diff --git a/_test_merge_api_base_8cs_source.html b/_test_merge_api_base_8cs_source.html index 621ca9cb34..964c9152b5 100644 --- a/_test_merge_api_base_8cs_source.html +++ b/_test_merge_api_base_8cs_source.html @@ -90,16 +90,16 @@ $(document).ready(function() { init_codefold(0); });
10 {
-
14 public long Id { get; set; }
-
15
-
19 [Required]
-
20 public DateTimeOffset MergedAt { get; set; }
-
21 }
+
15 public long Id { get; set; }
+
16
+
20 [Required]
+
21 public DateTimeOffset MergedAt { get; set; }
+
22 }
-
22}
+
23}
Represents a test merge of a remote commit source.
- -
DateTimeOffset MergedAt
When the TestMergeApiBase was created.
+ +
DateTimeOffset MergedAt
When the TestMergeApiBase was created.
Layer of test merge data required internally.
@ Required
DMAPI validation must suceed for the deployment to succeed.
diff --git a/_test_merge_model_base_8cs_source.html b/_test_merge_model_base_8cs_source.html index ef0834a48c..268d013214 100644 --- a/_test_merge_model_base_8cs_source.html +++ b/_test_merge_model_base_8cs_source.html @@ -90,54 +90,54 @@ $(document).ready(function() { init_codefold(0); });
9 public abstract class TestMergeModelBase : TestMergeParameters
10 {
-
14 [Required]
-
15 public string? TitleAtMerge { get; set; }
-
16
-
20 [Required]
-
21 public string? BodyAtMerge { get; set; }
-
22
-
26 [Required]
-
27#pragma warning disable CA1056 // Uri properties should not be strings
-
28 public string? Url { get; set; }
-
29#pragma warning restore CA1056 // Uri properties should not be strings
-
30
-
34 [Required]
-
35 public string? Author { get; set; }
-
36
-
- -
41 {
-
42 }
+
15 [Required]
+
16 public string? TitleAtMerge { get; set; }
+
17
+
22 [Required]
+
23 public string? BodyAtMerge { get; set; }
+
24
+
29 [Required]
+
30#pragma warning disable CA1056 // Uri properties should not be strings
+
31 public string? Url { get; set; }
+
32#pragma warning restore CA1056 // Uri properties should not be strings
+
33
+
38 [Required]
+
39 public string? Author { get; set; }
+
40
+
+ +
45 {
+
46 }
-
43
-
- -
49 {
-
50 if (copy == null)
-
51 throw new ArgumentNullException(nameof(copy));
-
52 Author = copy.Author;
- -
54 Comment = copy.Comment;
-
55 Number = copy.Number;
- - -
58 Url = copy.Url;
-
59 }
+
47
+
+ +
53 {
+
54 if (copy == null)
+
55 throw new ArgumentNullException(nameof(copy));
+
56 Author = copy.Author;
+ +
58 Comment = copy.Comment;
+
59 Number = copy.Number;
+ + +
62 Url = copy.Url;
+
63 }
-
60 }
+
64 }
-
61}
+
65}
Layer of test merge data required internally.
-
TestMergeModelBase(TestMergeModelBase copy)
Initializes a new instance of the TestMergeModelBase class.
-
TestMergeModelBase()
Initializes a new instance of the TestMergeModelBase class.
- -
string? BodyAtMerge
The body of the test merge source.
-
string? Author
The author of the test merge source.
-
string? TitleAtMerge
The title of the test merge source.
+
TestMergeModelBase(TestMergeModelBase copy)
Initializes a new instance of the TestMergeModelBase class.
+
TestMergeModelBase()
Initializes a new instance of the TestMergeModelBase class.
+ +
string? BodyAtMerge
The body of the test merge source.
+
string? Author
The author of the test merge source.
+
string? TitleAtMerge
The title of the test merge source.
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
-
string? Comment
Optional comment about the test.
-
int Number
The number of the test merge source.
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
string? Comment
Optional comment about the test.
+
int Number
The number of the test merge source.
@ Required
DMAPI validation must suceed for the deployment to succeed.
diff --git a/_test_merge_parameters_8cs_source.html b/_test_merge_parameters_8cs_source.html index f51827b2b2..8fc322b8c0 100644 --- a/_test_merge_parameters_8cs_source.html +++ b/_test_merge_parameters_8cs_source.html @@ -89,24 +89,25 @@ $(document).ready(function() { init_codefold(0); });
8 public class TestMergeParameters
9 {
-
13 public int Number { get; set; }
-
14
-
18 [Required]
-
19 [StringLength(40)]
-
20 public virtual string? TargetCommitSha { get; set; }
-
21
-
25 [ResponseOptions]
-
26 [StringLength(Limits.MaximumStringLength)]
-
27 public string? Comment { get; set; }
-
28 }
+
14 public int Number { get; set; }
+
15
+
20 [Required]
+
21 [StringLength(Limits.MaximumCommitShaLength, MinimumLength = Limits.MaximumCommitShaLength)]
+
22 public virtual string? TargetCommitSha { get; set; }
+
23
+
28 [ResponseOptions]
+
29 [StringLength(Limits.MaximumStringLength)]
+
30 public string? Comment { get; set; }
+
31 }
-
29}
+
32}
Sanity limits to prevent users from overloading.
Definition Limits.cs:9
const int MaximumStringLength
Length limit for strings in fields.
Definition Limits.cs:13
+
const int MaximumCommitShaLength
Length limit for git commit SHAs.
Definition Limits.cs:28
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
-
string? Comment
Optional comment about the test.
-
int Number
The number of the test merge source.
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
string? Comment
Optional comment about the test.
+
int Number
The number of the test merge source.
@ Required
DMAPI validation must suceed for the deployment to succeed.
diff --git a/_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html b/_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html index 3c073bd393..3aab72827e 100644 --- a/_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html +++ b/_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html @@ -92,15 +92,15 @@ $(document).ready(function() { init_codefold(0); });
11 {
-
17 [Required]
-
18 [StringLength(Limits.MaximumIndexableStringLength, MinimumLength = 1)]
-
19 public string? ChannelData { get; set; }
-
20 }
+
18 [Required]
+
19 [StringLength(Limits.MaximumIndexableStringLength, MinimumLength = 1)]
+
20 public string? ChannelData { get; set; }
+
21 }
-
21}
+
22}
-
string? ChannelData
The channel identifier. For ChatProvider.Irc, it's the IRC channel name and optional password colon s...
+
string? ChannelData
The channel identifier. For ChatProvider.Irc, it's the IRC channel name and optional password colon s...
Sanity limits to prevent users from overloading.
Definition Limits.cs:9
const int MaximumIndexableStringLength
Length limit for NamedEntity.Names.
Definition Limits.cs:23
diff --git a/_tgstation_8_server_8_api_2_models_2_internal_2_compile_job_8cs_source.html b/_tgstation_8_server_8_api_2_models_2_internal_2_compile_job_8cs_source.html index 090bfdfebe..a4e8e3b541 100644 --- a/_tgstation_8_server_8_api_2_models_2_internal_2_compile_job_8cs_source.html +++ b/_tgstation_8_server_8_api_2_models_2_internal_2_compile_job_8cs_source.html @@ -91,31 +91,31 @@ $(document).ready(function() { init_codefold(0); });
10 public abstract class CompileJob : EntityId
11 {
-
15 [Required]
-
16 public string? DmeName { get; set; }
-
17
-
21 [Required]
-
22 public string? Output { get; set; }
-
23
-
27 [Required]
-
28 public Guid? DirectoryName { get; set; }
-
29
-
33 [ResponseOptions]
- -
35
-
39 [NotMapped]
-
40 [ResponseOptions]
-
41 public virtual Version? DMApiVersion { get; set; }
-
42 }
+
16 [Required]
+
17 public string? DmeName { get; set; }
+
18
+
22 [Required]
+
23 public string? Output { get; set; }
+
24
+
28 [Required]
+
29 public Guid? DirectoryName { get; set; }
+
30
+
34 [ResponseOptions]
+ +
36
+
41 [NotMapped]
+
42 [ResponseOptions]
+
43 public virtual Version? DMApiVersion { get; set; }
+
44 }
-
43}
+
45}
Common base of entities with IDs.
Definition EntityId.cs:7
-
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:16
-
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:41
-
DreamDaemonSecurity? MinimumSecurityLevel
The minimum DreamDaemonSecurity required to run the CompileJob's output.
Definition CompileJob.cs:34
- -
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:28
+
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:17
+
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:43
+
DreamDaemonSecurity? MinimumSecurityLevel
The minimum DreamDaemonSecurity required to run the CompileJob's output.
Definition CompileJob.cs:35
+ +
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:29
DreamDaemonSecurity
DreamDaemon's security level.
@ Required
DMAPI validation must suceed for the deployment to succeed.
diff --git a/_tgstation_8_server_8_api_2_models_2_internal_2_job_8cs_source.html b/_tgstation_8_server_8_api_2_models_2_internal_2_job_8cs_source.html index a3d1e323b8..f84c92dbf4 100644 --- a/_tgstation_8_server_8_api_2_models_2_internal_2_job_8cs_source.html +++ b/_tgstation_8_server_8_api_2_models_2_internal_2_job_8cs_source.html @@ -95,41 +95,41 @@ $(document).ready(function() { init_codefold(0); });
16 [Required]
17 public JobCode? JobCode { get; set; }
18
-
23 [Required]
-
24 public string? Description { get; set; }
-
25
- -
30 public ErrorCode? ErrorCode { get; set; }
-
31
- -
36 public string? ExceptionDetails { get; set; }
-
37
-
41 [Required]
-
42 public DateTimeOffset? StartedAt { get; set; }
-
43
- -
48 public DateTimeOffset? StoppedAt { get; set; }
-
49
-
53 [Required]
-
54 public bool? Cancelled { get; set; }
-
55
- -
60 public RightsType? CancelRightsType { get; set; }
-
61
- -
66 public ulong? CancelRight { get; set; }
-
67 }
+
24 [Required]
+
25 public string? Description { get; set; }
+
26
+ +
31 public ErrorCode? ErrorCode { get; set; }
+
32
+ +
37 public string? ExceptionDetails { get; set; }
+
38
+
42 [Required]
+
43 public DateTimeOffset? StartedAt { get; set; }
+
44
+ +
49 public DateTimeOffset? StoppedAt { get; set; }
+
50
+
55 [Required]
+
56 public bool? Cancelled { get; set; }
+
57
+ +
62 public RightsType? CancelRightsType { get; set; }
+
63
+ +
68 public ulong? CancelRight { get; set; }
+
69 }
-
68}
+
70}
Common base of entities with IDs.
Definition EntityId.cs:7
Represents a long running job.
Definition Job.cs:12
-
DateTimeOffset? StartedAt
When the Job was started.
Definition Job.cs:42
-
DateTimeOffset? StoppedAt
When the Job stopped.
Definition Job.cs:48
-
string? Description
English description of the Job.
Definition Job.cs:24
-
RightsType? CancelRightsType
The RightsType of CancelRight if it can be cancelled.
Definition Job.cs:60
-
bool? Cancelled
If the Job was cancelled.
Definition Job.cs:54
-
ulong? CancelRight
The Rights required to cancel the Job.
Definition Job.cs:66
-
string? ExceptionDetails
Details of any exceptions caught during the Job.
Definition Job.cs:36
+
DateTimeOffset? StartedAt
When the Job was started.
Definition Job.cs:43
+
DateTimeOffset? StoppedAt
When the Job stopped.
Definition Job.cs:49
+
string? Description
English description of the Job.
Definition Job.cs:25
+
RightsType? CancelRightsType
The RightsType of CancelRight if it can be cancelled.
Definition Job.cs:62
+
bool? Cancelled
If the Job was cancelled.
Definition Job.cs:56
+
ulong? CancelRight
The Rights required to cancel the Job.
Definition Job.cs:68
+
string? ExceptionDetails
Details of any exceptions caught during the Job.
Definition Job.cs:37
ErrorCode
Types of Response.ErrorMessageResponses that the API may return.
Definition ErrorCode.cs:12
JobCode
The different types of Response.JobResponse.
Definition JobCode.cs:9
diff --git a/_tgstation_8_server_8_api_2_models_2_internal_2_update_information_8cs_source.html b/_tgstation_8_server_8_api_2_models_2_internal_2_update_information_8cs_source.html index b39b214c40..218ff626f7 100644 --- a/_tgstation_8_server_8_api_2_models_2_internal_2_update_information_8cs_source.html +++ b/_tgstation_8_server_8_api_2_models_2_internal_2_update_information_8cs_source.html @@ -89,15 +89,15 @@ $(document).ready(function() { init_codefold(0); });
8 public class UpdateInformation
9 {
-
13 public Version? LatestVersion { get; set; }
-
14
-
18 public DateTimeOffset? GeneratedAt { get; set; }
-
19 }
+
14 public Version? LatestVersion { get; set; }
+
15
+
19 public DateTimeOffset? GeneratedAt { get; set; }
+
20 }
-
20}
+
21}
Indicates data from the TGS update source.
-
DateTimeOffset? GeneratedAt
This response is cached. This field indicates the DateTimeOffset the UpdateInformation was generated.
-
Version? LatestVersion
The latest available version of the Tgstation.Server.Host assembly from the upstream repository....
+
DateTimeOffset? GeneratedAt
This response is cached. This field indicates the DateTimeOffset the UpdateInformation was generated.
+
Version? LatestVersion
The latest available version of the Tgstation.Server.Host assembly from the upstream repository....
diff --git a/_tgstation_8_server_8_api_2_models_2_internal_2_user_group_8cs_source.html b/_tgstation_8_server_8_api_2_models_2_internal_2_user_group_8cs_source.html index ea3f6eae68..1768aad3ed 100644 --- a/_tgstation_8_server_8_api_2_models_2_internal_2_user_group_8cs_source.html +++ b/_tgstation_8_server_8_api_2_models_2_internal_2_user_group_8cs_source.html @@ -100,7 +100,7 @@ $(document).ready(function() { init_codefold(0); });
20 }
21}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Internal.UserGroup
Represents a group of users.
Definition UserGroup.cs:7
Tgstation.Server.Api.Models.Internal.UserGroup.Id
override? long Id
Definition UserGroup.cs:11
Tgstation.Server.Api.Models.NamedEntity
Base class for named entities.
Definition NamedEntity.cs:9
diff --git a/_tgstation_8_server_8_api_2_models_2_named_entity_8cs_source.html b/_tgstation_8_server_8_api_2_models_2_named_entity_8cs_source.html index a6fd7ec9ef..ac1ea31f28 100644 --- a/_tgstation_8_server_8_api_2_models_2_named_entity_8cs_source.html +++ b/_tgstation_8_server_8_api_2_models_2_named_entity_8cs_source.html @@ -89,18 +89,18 @@ $(document).ready(function() { init_codefold(0); });
8 public abstract class NamedEntity : EntityId
9 {
-
13 [Required]
-
14 [RequestOptions(FieldPresence.Required, PutOnly = true)]
-
15 [StringLength(Limits.MaximumIndexableStringLength, MinimumLength = 1)]
-
16 public virtual string? Name { get; set; }
-
17 }
+
14 [Required]
+
15 [RequestOptions(FieldPresence.Required, PutOnly = true)]
+
16 [StringLength(Limits.MaximumIndexableStringLength, MinimumLength = 1)]
+
17 public virtual string? Name { get; set; }
+
18 }
-
18}
+
19}
Tgstation.Server.Api.Models.EntityId
Common base of entities with IDs.
Definition EntityId.cs:7
Tgstation.Server.Api.Models.Limits
Sanity limits to prevent users from overloading.
Definition Limits.cs:9
Tgstation.Server.Api.Models.Limits.MaximumIndexableStringLength
const int MaximumIndexableStringLength
Length limit for NamedEntity.Names.
Definition Limits.cs:23
Tgstation.Server.Api.Models.NamedEntity
Base class for named entities.
Definition NamedEntity.cs:9
-
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:16
+
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:17
Tgstation.Server.Api.Models
Definition ChatChannel.cs:6
Tgstation.Server.Api.Models.FieldPresence
FieldPresence
Indicates whether a request field is Required or Ignored.
Definition FieldPresence.cs:7
Tgstation.Server.Api.Models.DMApiValidationMode.Required
@ Required
DMAPI validation must suceed for the deployment to succeed.
diff --git a/_tgstation_8_server_8_api_2_models_2_permission_set_8cs_source.html b/_tgstation_8_server_8_api_2_models_2_permission_set_8cs_source.html index c9bb7ac373..1ff1f61fd1 100644 --- a/_tgstation_8_server_8_api_2_models_2_permission_set_8cs_source.html +++ b/_tgstation_8_server_8_api_2_models_2_permission_set_8cs_source.html @@ -109,7 +109,7 @@ $(document).ready(function() { init_codefold(0); });
32}
Tgstation.Server.Api.Models.EntityId
Common base of entities with IDs.
Definition EntityId.cs:7
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.PermissionSet
Represents a set of server permissions.
Definition PermissionSet.cs:11
Tgstation.Server.Api.Models.PermissionSet.Id
override? long Id
Definition PermissionSet.cs:15
Tgstation.Server.Api.Models
Definition ChatChannel.cs:6
diff --git a/_tgstation_8_server_8_api_2_models_2_user_name_8cs_source.html b/_tgstation_8_server_8_api_2_models_2_user_name_8cs_source.html index 6f91cef031..785385baed 100644 --- a/_tgstation_8_server_8_api_2_models_2_user_name_8cs_source.html +++ b/_tgstation_8_server_8_api_2_models_2_user_name_8cs_source.html @@ -87,34 +87,34 @@ $(document).ready(function() { init_codefold(0); });
6 public class UserName : NamedEntity
7 {
-
9 [RequestOptions(FieldPresence.Optional)]
-
-
10 public override string? Name
-
11 {
-
12 get => base.Name;
-
13 set => base.Name = value;
-
14 }
+
10 [RequestOptions(FieldPresence.Optional)]
+
+
11 public override string? Name
+
12 {
+
13 get => base.Name;
+
14 set => base.Name = value;
+
15 }
-
15
-
20 public UserName CreateUserName() => CreateUserName<UserName>();
-
21
-
-
27 protected virtual TResultType CreateUserName<TResultType>()
-
28 where TResultType : UserName, new() => new()
-
29 {
-
30 Id = Id,
-
31 Name = Name,
-
32 };
+
16
+
21 public UserName CreateUserName() => CreateUserName<UserName>();
+
22
+
+
28 protected virtual TResultType CreateUserName<TResultType>()
+
29 where TResultType : UserName, new() => new()
+
30 {
+
31 Id = Id,
+
32 Name = Name,
+
33 };
-
33 }
+
34 }
-
34}
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
35}
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Base class for named entities.
Definition NamedEntity.cs:9
-
virtual ? string Name
The name of the entity represented by the NamedEntity.
+
virtual ? string Name
The name of the entity represented by the NamedEntity.
Base class for user names.
Definition UserName.cs:7
-
virtual TResultType CreateUserName< TResultType >()
Create a copy of the UserName as a given TResultType .
Definition UserName.cs:27
- +
virtual TResultType CreateUserName< TResultType >()
Create a copy of the UserName as a given TResultType .
Definition UserName.cs:28
+
UserName CreateUserName()
Create a copy of the UserName.
FieldPresence
Indicates whether a request field is Required or Ignored.
diff --git a/_tgstation_8_server_8_host_2_models_2_chat_channel_8cs_source.html b/_tgstation_8_server_8_host_2_models_2_chat_channel_8cs_source.html index ddb4503e71..84242d8a7a 100644 --- a/_tgstation_8_server_8_host_2_models_2_chat_channel_8cs_source.html +++ b/_tgstation_8_server_8_host_2_models_2_chat_channel_8cs_source.html @@ -120,11 +120,11 @@ $(document).ready(function() { init_codefold(0); });
53}
-
bool? IsUpdatesChannel
If the ChatChannel is an updates channel.
-
string? Tag
A custom tag users can define to group channels together.
-
bool? IsSystemChannel
If the ChatChannel received system messages.
-
bool? IsWatchdogChannel
If the ChatChannel is a watchdog channel.
-
bool? IsAdminChannel
If the ChatChannel is an admin channel.
+
bool? IsUpdatesChannel
If the ChatChannel is an updates channel.
+
string? Tag
A custom tag users can define to group channels together.
+
bool? IsSystemChannel
If the ChatChannel received system messages.
+
bool? IsWatchdogChannel
If the ChatChannel is a watchdog channel.
+
bool? IsAdminChannel
If the ChatChannel is an admin channel.
Sanity limits to prevent users from overloading.
Definition Limits.cs:9
const int MaximumIndexableStringLength
Length limit for NamedEntity.Names.
Definition Limits.cs:23
diff --git a/_tgstation_8_server_8_host_2_models_2_compile_job_8cs_source.html b/_tgstation_8_server_8_host_2_models_2_compile_job_8cs_source.html index 7128b78914..e4b106d4ab 100644 --- a/_tgstation_8_server_8_host_2_models_2_compile_job_8cs_source.html +++ b/_tgstation_8_server_8_host_2_models_2_compile_job_8cs_source.html @@ -188,11 +188,11 @@ $(document).ready(function() { init_codefold(0); });
142}
Information about an engine installation.
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:16
-
DreamDaemonSecurity? MinimumSecurityLevel
The minimum DreamDaemonSecurity required to run the CompileJob's output.
Definition CompileJob.cs:34
-
string? Output
Textual output of DM.
Definition CompileJob.cs:22
-
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:28
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:17
+
DreamDaemonSecurity? MinimumSecurityLevel
The minimum DreamDaemonSecurity required to run the CompileJob's output.
Definition CompileJob.cs:35
+
string? Output
Textual output of DM.
Definition CompileJob.cs:23
+
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:29
Definition CompileJob.cs:11
int? DMApiMinorVersion
Backing field for Version.Minor of DMApiVersion.
Definition CompileJob.cs:43
diff --git a/_tgstation_8_server_8_host_2_models_2_instance_8cs_source.html b/_tgstation_8_server_8_host_2_models_2_instance_8cs_source.html index 2edc320bef..f8ba9d39d4 100644 --- a/_tgstation_8_server_8_host_2_models_2_instance_8cs_source.html +++ b/_tgstation_8_server_8_host_2_models_2_instance_8cs_source.html @@ -137,7 +137,7 @@ $(document).ready(function() { init_codefold(0); });
82 }
83}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance.AutoStartCron
string? AutoStartCron
A cron expression indicating when the game server should start. Must be a valid 6 part cron schedule ...
Definition Instance.cs:58
Tgstation.Server.Api.Models.Instance.ConfigurationType
ConfigurationType? ConfigurationType
If IConfigurationFiles can be used on the Instance.
Definition Instance.cs:29
Tgstation.Server.Api.Models.Instance.Online
bool? Online
If the Instance is online.
Definition Instance.cs:22
@@ -146,7 +146,7 @@ $(document).ready(function() { init_codefold(0); });
Tgstation.Server.Api.Models.Instance.ChatBotLimit
ushort? ChatBotLimit
The maximum number of chat bots the Instance may contain.
Definition Instance.cs:50
Tgstation.Server.Api.Models.Instance.AutoStopCron
string? AutoStopCron
A cron expression indicating when the game server should stop. Must be a valid 6 part cron schedule (...
Definition Instance.cs:66
Tgstation.Server.Api.Models.Instance.AutoUpdateInterval
uint? AutoUpdateInterval
The time interval in minutes the repository is automatically pulled and compiles. 0 disables.
Definition Instance.cs:36
-
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:16
+
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:17
Tgstation.Server.Api.Models.Response.InstanceResponse
Server response for Instances.
Definition InstanceResponse.cs:7
Tgstation.Server.Host.Models.DreamDaemonSettings
Definition DreamDaemonSettings.cs:7
Tgstation.Server.Host.Models.DreamMakerSettings
Definition DreamMakerSettings.cs:9
diff --git a/_tgstation_8_server_8_host_2_models_2_job_8cs_source.html b/_tgstation_8_server_8_host_2_models_2_job_8cs_source.html index a1f7c2d3b0..b6155b4c94 100644 --- a/_tgstation_8_server_8_host_2_models_2_job_8cs_source.html +++ b/_tgstation_8_server_8_host_2_models_2_job_8cs_source.html @@ -179,15 +179,15 @@ $(document).ready(function() { init_codefold(0); });
128 }
129}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
Tgstation.Server.Api.Models.Internal.Job.StartedAt
DateTimeOffset? StartedAt
When the Job was started.
Definition Job.cs:42
-
Tgstation.Server.Api.Models.Internal.Job.StoppedAt
DateTimeOffset? StoppedAt
When the Job stopped.
Definition Job.cs:48
-
Tgstation.Server.Api.Models.Internal.Job.Description
string? Description
English description of the Job.
Definition Job.cs:24
-
Tgstation.Server.Api.Models.Internal.Job.CancelRightsType
RightsType? CancelRightsType
The RightsType of CancelRight if it can be cancelled.
Definition Job.cs:60
-
Tgstation.Server.Api.Models.Internal.Job.ErrorCode
ErrorCode? ErrorCode
The Models.ErrorCode associated with the Job if any.
Definition Job.cs:30
-
Tgstation.Server.Api.Models.Internal.Job.Cancelled
bool? Cancelled
If the Job was cancelled.
Definition Job.cs:54
-
Tgstation.Server.Api.Models.Internal.Job.CancelRight
ulong? CancelRight
The Rights required to cancel the Job.
Definition Job.cs:66
-
Tgstation.Server.Api.Models.Internal.Job.ExceptionDetails
string? ExceptionDetails
Details of any exceptions caught during the Job.
Definition Job.cs:36
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
Tgstation.Server.Api.Models.Internal.Job.StartedAt
DateTimeOffset? StartedAt
When the Job was started.
Definition Job.cs:43
+
Tgstation.Server.Api.Models.Internal.Job.StoppedAt
DateTimeOffset? StoppedAt
When the Job stopped.
Definition Job.cs:49
+
Tgstation.Server.Api.Models.Internal.Job.Description
string? Description
English description of the Job.
Definition Job.cs:25
+
Tgstation.Server.Api.Models.Internal.Job.CancelRightsType
RightsType? CancelRightsType
The RightsType of CancelRight if it can be cancelled.
Definition Job.cs:62
+
Tgstation.Server.Api.Models.Internal.Job.ErrorCode
ErrorCode? ErrorCode
The Models.ErrorCode associated with the Job if any.
Definition Job.cs:31
+
Tgstation.Server.Api.Models.Internal.Job.Cancelled
bool? Cancelled
If the Job was cancelled.
Definition Job.cs:56
+
Tgstation.Server.Api.Models.Internal.Job.CancelRight
ulong? CancelRight
The Rights required to cancel the Job.
Definition Job.cs:68
+
Tgstation.Server.Api.Models.Internal.Job.ExceptionDetails
string? ExceptionDetails
Details of any exceptions caught during the Job.
Definition Job.cs:37
Tgstation.Server.Api.Models.Response.JobResponse
Represents a long running job on the server. Model is read-only, updates attempt to cancel the job.
Definition JobResponse.cs:7
Tgstation.Server.Api.Models.UserName.CreateUserName
UserName CreateUserName()
Create a copy of the UserName.
Tgstation.Server.Api.Rights.RightsHelper
Helper for RightsTypes.
Definition RightsHelper.cs:12
diff --git a/_tgstation_8_server_8_host_2_models_2_test_merge_8cs_source.html b/_tgstation_8_server_8_host_2_models_2_test_merge_8cs_source.html index 7c4fdc99cf..df495afbb0 100644 --- a/_tgstation_8_server_8_host_2_models_2_test_merge_8cs_source.html +++ b/_tgstation_8_server_8_host_2_models_2_test_merge_8cs_source.html @@ -119,16 +119,16 @@ $(document).ready(function() { init_codefold(0); });
46 }
47}
-
Tgstation.Server.Api.Models.Internal.TestMergeApiBase.Id
long Id
The ID of the TestMergeApiBase.
Definition TestMergeApiBase.cs:14
-
Tgstation.Server.Api.Models.Internal.TestMergeApiBase.MergedAt
DateTimeOffset MergedAt
When the TestMergeApiBase was created.
Definition TestMergeApiBase.cs:20
-
Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Url
string? Url
The URL of the test merge source.
Definition TestMergeModelBase.cs:28
-
Tgstation.Server.Api.Models.Internal.TestMergeModelBase.BodyAtMerge
string? BodyAtMerge
The body of the test merge source.
Definition TestMergeModelBase.cs:21
-
Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Author
string? Author
The author of the test merge source.
Definition TestMergeModelBase.cs:35
-
Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TitleAtMerge
string? TitleAtMerge
The title of the test merge source.
Definition TestMergeModelBase.cs:15
+
Tgstation.Server.Api.Models.Internal.TestMergeApiBase.Id
long Id
The ID of the TestMergeApiBase.
Definition TestMergeApiBase.cs:15
+
Tgstation.Server.Api.Models.Internal.TestMergeApiBase.MergedAt
DateTimeOffset MergedAt
When the TestMergeApiBase was created.
Definition TestMergeApiBase.cs:21
+
Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Url
string? Url
The URL of the test merge source.
Definition TestMergeModelBase.cs:31
+
Tgstation.Server.Api.Models.Internal.TestMergeModelBase.BodyAtMerge
string? BodyAtMerge
The body of the test merge source.
Definition TestMergeModelBase.cs:23
+
Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Author
string? Author
The author of the test merge source.
Definition TestMergeModelBase.cs:39
+
Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TitleAtMerge
string? TitleAtMerge
The title of the test merge source.
Definition TestMergeModelBase.cs:16
Tgstation.Server.Api.Models.TestMerge
Definition TestMerge.cs:7
-
Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
Definition TestMergeParameters.cs:20
-
Tgstation.Server.Api.Models.TestMergeParameters.Comment
string? Comment
Optional comment about the test.
Definition TestMergeParameters.cs:27
-
Tgstation.Server.Api.Models.TestMergeParameters.Number
int Number
The number of the test merge source.
Definition TestMergeParameters.cs:13
+
Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
Definition TestMergeParameters.cs:22
+
Tgstation.Server.Api.Models.TestMergeParameters.Comment
string? Comment
Optional comment about the test.
Definition TestMergeParameters.cs:30
+
Tgstation.Server.Api.Models.TestMergeParameters.Number
int Number
The number of the test merge source.
Definition TestMergeParameters.cs:14
Tgstation.Server.Host.Models.RevisionInformation
Definition RevisionInformation.cs:10
Tgstation.Server.Host.Models.TestMerge
Definition TestMerge.cs:9
Tgstation.Server.Host.Models.TestMerge.PrimaryRevisionInformationId
long? PrimaryRevisionInformationId
Foreign key for PrimaryRevisionInformation.
Definition TestMerge.cs:25
diff --git a/_tgstation_8_server_8_host_2_models_2_user_group_8cs_source.html b/_tgstation_8_server_8_host_2_models_2_user_group_8cs_source.html index cc5de884a3..4da454f181 100644 --- a/_tgstation_8_server_8_host_2_models_2_user_group_8cs_source.html +++ b/_tgstation_8_server_8_host_2_models_2_user_group_8cs_source.html @@ -120,9 +120,9 @@ $(document).ready(function() { init_codefold(0); });
48 }
49}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.NamedEntity
Base class for named entities.
Definition NamedEntity.cs:9
-
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:16
+
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:17
Tgstation.Server.Api.Models.Response.UserGroupResponse
Definition UserGroupResponse.cs:9
Tgstation.Server.Host.Models.PermissionSet
Definition PermissionSet.cs:9
Tgstation.Server.Host.Models.UserGroup
Represents a group of Users.
Definition UserGroup.cs:16
diff --git a/_token_response_8cs_source.html b/_token_response_8cs_source.html index ca413e62dd..0b8d1f18b7 100644 --- a/_token_response_8cs_source.html +++ b/_token_response_8cs_source.html @@ -89,14 +89,14 @@ $(document).ready(function() { init_codefold(0); });
8 public sealed class TokenResponse
9 {
-
13 public string? Bearer { get; set; }
-
14
-
19 public JsonWebToken ParseJwt() => new(Bearer);
-
20 }
+
14 public string? Bearer { get; set; }
+
15
+
20 public JsonWebToken ParseJwt() => new(Bearer);
+
21 }
-
21}
+
22}
Tgstation.Server.Api.Models.Response.TokenResponse
Represents a JWT returned by the API.
Definition TokenResponse.cs:9
-
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:13
+
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:14
Tgstation.Server.Api.Models.Response.TokenResponse.ParseJwt
JsonWebToken ParseJwt()
Parses the Bearer as a JsonWebToken.
Tgstation.Server.Api.Models.Response
Definition AdministrationResponse.cs:6
diff --git a/_user_authority_8cs_source.html b/_user_authority_8cs_source.html index 1ad530f262..8f8b882ae1 100644 --- a/_user_authority_8cs_source.html +++ b/_user_authority_8cs_source.html @@ -643,7 +643,7 @@ $(document).ready(function() { init_codefold(0); });
IQueryable
Tgstation.Server.Api.DefaultCredentials
Represents initial credentials used by the server.
Definition DefaultCredentials.cs:7
Tgstation.Server.Api.DefaultCredentials.AdminUserName
static readonly string AdminUserName
The name of the default admin user.
Definition DefaultCredentials.cs:11
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.PermissionSet
Represents a set of server permissions.
Definition PermissionSet.cs:11
Tgstation.Server.Api.Models.PermissionSet.AdministrationRights
AdministrationRights? AdministrationRights
The Rights.AdministrationRights for the user.
Definition PermissionSet.cs:24
Tgstation.Server.Api.Models.Request.UserCreateRequest
For creating a user.
Definition UserCreateRequest.cs:7
diff --git a/_user_controller_8cs_source.html b/_user_controller_8cs_source.html index 84dab56537..3e383f3808 100644 --- a/_user_controller_8cs_source.html +++ b/_user_controller_8cs_source.html @@ -185,7 +185,7 @@ $(document).ready(function() { init_codefold(0); });
150 }
151}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Request.UserCreateRequest
For creating a user.
Definition UserCreateRequest.cs:7
Tgstation.Server.Api.Models.Request.UserUpdateRequest
For editing a given user.
Definition UserUpdateRequest.cs:11
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
diff --git a/_user_mutations_8cs_source.html b/_user_mutations_8cs_source.html index f74f2f900e..d7bf699b16 100644 --- a/_user_mutations_8cs_source.html +++ b/_user_mutations_8cs_source.html @@ -522,7 +522,7 @@ $(document).ready(function() { init_codefold(0); });
544 }
545}
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Internal.UserGroup
Represents a group of users.
Definition UserGroup.cs:7
Tgstation.Server.Api.Models.PermissionSet
Represents a set of server permissions.
Definition PermissionSet.cs:11
Tgstation.Server.Api.Models.PermissionSet.InstanceManagerRights
InstanceManagerRights? InstanceManagerRights
The Rights.InstanceManagerRights for the user.
Definition PermissionSet.cs:30
diff --git a/_watchdog_base_8cs_source.html b/_watchdog_base_8cs_source.html index 604ffba447..3232cdf4f7 100644 --- a/_watchdog_base_8cs_source.html +++ b/_watchdog_base_8cs_source.html @@ -1201,12 +1201,12 @@ $(document).ready(function() { init_codefold(0); });
1275}
Exception
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.CompileJob
Represents a deployment run.
Definition CompileJob.cs:11
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters
Launch settings for DreamDaemon.
Definition DreamDaemonLaunchParameters.cs:10
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.HealthCheckSeconds
uint? HealthCheckSeconds
The number of seconds between each watchdog health check. 0 disables.
Definition DreamDaemonLaunchParameters.cs:69
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.DumpOnHealthCheckRestart
bool? DumpOnHealthCheckRestart
If a process core dump should be created prior to restarting the watchdog due to health check failure...
Definition DreamDaemonLaunchParameters.cs:76
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.HealthCheckSeconds
uint? HealthCheckSeconds
The number of seconds between each watchdog health check. 0 disables.
Definition DreamDaemonLaunchParameters.cs:76
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.DumpOnHealthCheckRestart
bool? DumpOnHealthCheckRestart
If a process core dump should be created prior to restarting the watchdog due to health check failure...
Definition DreamDaemonLaunchParameters.cs:83
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
Tgstation.Server.Host.Components.Chat.ChatUser
Represents a tgs_chat_user datum.
Definition ChatUser.cs:12
diff --git a/_windows_byond_installer_8cs_source.html b/_windows_byond_installer_8cs_source.html index 8824c4f745..2f5ded4b23 100644 --- a/_windows_byond_installer_8cs_source.html +++ b/_windows_byond_installer_8cs_source.html @@ -382,7 +382,7 @@ $(document).ready(function() { init_codefold(0); });
Exception
IDisposable
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:30
+
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:31
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
Tgstation.Server.Host.Components.Engine.ByondInstallerBase
Base implementation of IEngineInstaller for EngineType.Byond.
Definition ByondInstallerBase.cs:20
diff --git a/changelog.yml b/changelog.yml index ca6d7e73ed..0ca1e9b6e6 100644 --- a/changelog.yml +++ b/changelog.yml @@ -183,7 +183,7 @@ Components: InteropApi: 5.10.0 HostWatchdog: 1.6.0 NugetCommon: 7.0.0 - NugetApi: 17.0.0 + NugetApi: 17.0.1 NugetClient: 20.0.0 WebControlPanel: 6.7.3 Changes: [] @@ -4080,6 +4080,13 @@ Components: - Added `autoStartCron` and `autoStopCron` to Instance model. Functions identically to `autoUpdateCron` but will instead launch and gracefully shutdown the server respectively. Added instance rights 2048 and 4096 to adjust these respectively. Author: Cyberboss PullRequest: 1998 + - Descriptions: + - Flatten class names. + - Add dummy "example" data. + - Add some basic description to the authentication methods. + Author: LetterN + PullRequest: 2087 + Unreleased: true - Version: 10.11.0 Changes: - Descriptions: diff --git a/class_tgstation_1_1_server_1_1_api_1_1_api_headers.html b/class_tgstation_1_1_server_1_1_api_1_1_api_headers.html index 3570cc376b..4435ea1923 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_api_headers.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_api_headers.html @@ -266,9 +266,9 @@ Static Private Attributes
150 if (token.Bearer == null)
151 throw new InvalidOperationException("token.Bearer must be set!");
152 }
-
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:13
+
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:14
-

References Tgstation.Server.Api.Models.Response.TokenResponse.Bearer.

+

References Tgstation.Server.Api.Models.Response.TokenResponse.Bearer.

@@ -1053,7 +1053,7 @@ Here is the caller graph for this function:

Definition at line 49 of file ApiHeaders.cs.

-

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromLogin(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

+

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromLogin(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

@@ -1081,7 +1081,7 @@ Here is the caller graph for this function:

Definition at line 44 of file ApiHeaders.cs.

-

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromToken(), Tgstation.Server.Host.IO.FileDownloader.DownloadFile(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Host.Security.OAuth.GenericOAuthValidator.ValidateResponseCode().

+

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromToken(), Tgstation.Server.Host.IO.FileDownloader.DownloadFile(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Host.Security.OAuth.GenericOAuthValidator.ValidateResponseCode().

@@ -1137,7 +1137,7 @@ Here is the caller graph for this function:

Definition at line 34 of file ApiHeaders.cs.

-

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

+

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

@@ -1165,7 +1165,7 @@ Here is the caller graph for this function:

Definition at line 54 of file ApiHeaders.cs.

-

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromOAuth(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

+

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.CreateFromOAuth(), and Tgstation.Server.Api.ApiHeaders.SetRequestHeaders().

@@ -1193,7 +1193,7 @@ Here is the caller graph for this function:

Definition at line 39 of file ApiHeaders.cs.

-

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.SetupServiceProvider().

+

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), Tgstation.Server.Api.ApiHeaders.SetRequestHeaders(), and Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.SetupServiceProvider().

@@ -1249,7 +1249,7 @@ Here is the caller graph for this function:

Definition at line 69 of file ApiHeaders.cs.

-

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorMessageResponse(), Tgstation.Server.Host.Controllers.ControlPanelController.GetChannelJson(), and Tgstation.Server.Host.Controllers.ApiRootController.ServerInfo().

+

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Api.ApiHeaders.ApiHeaders(), Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorMessageResponse(), Tgstation.Server.Host.Controllers.ControlPanelController.GetChannelJson(), and Tgstation.Server.Host.Controllers.ApiRootController.ServerInfo().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_chat_channel.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_chat_channel.html index 787efc138d..ec35cd70f6 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_chat_channel.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_chat_channel.html @@ -152,9 +152,10 @@ Properties

The channel identifier. For ChatProvider.Irc, it's the IRC channel name and optional password colon separated. For ChatProvider.Discord, it's the stringified Discord channel snowflake.

+

124823852418

-

Definition at line 19 of file ChatChannel.cs.

-
19{ get; set; }
+

Definition at line 20 of file ChatChannel.cs.

+
20{ get; set; }
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html index bdab56b9cd..fc55c34c18 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_engine_version.html @@ -178,9 +178,9 @@ Static Private Attributes

Initializes a new instance of the EngineVersion class.

-

Definition at line 138 of file EngineVersion.cs.

-
139 {
-
140 }
+

Definition at line 140 of file EngineVersion.cs.

+
141 {
+
142 }
@@ -208,22 +208,22 @@ Static Private Attributes -

Definition at line 146 of file EngineVersion.cs.

-
147 {
-
148 if (other == null)
-
149 throw new ArgumentNullException(nameof(other));
-
150
-
151 Version = other.Version;
-
152 Engine = other.Engine;
-
153 SourceSHA = other.SourceSHA;
-
154 CustomIteration = other.CustomIteration;
-
155 }
-
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
-
string? SourceSHA
The git commit SHA of the engine. Currently only valid when Engine is EngineType.OpenDream.
+

Definition at line 148 of file EngineVersion.cs.

+
149 {
+
150 if (other == null)
+
151 throw new ArgumentNullException(nameof(other));
+
152
+
153 Version = other.Version;
+
154 Engine = other.Engine;
+
155 SourceSHA = other.SourceSHA;
+
156 CustomIteration = other.CustomIteration;
+
157 }
+
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
+
string? SourceSHA
The git commit SHA of the engine. Currently only valid when Engine is EngineType.OpenDream.
-
int? CustomIteration
The revision of the custom build.
+
int? CustomIteration
The revision of the custom build.
-

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

+

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

@@ -246,21 +246,21 @@ Static Private Attributes

-

Definition at line 158 of file EngineVersion.cs.

-
159 {
-
160 // https://github.com/dotnet/roslyn-analyzers/issues/2875
-
161#pragma warning disable CA1062 // Validate arguments of public methods
-
162 return other!.Version?.Semver() == Version?.Semver()
-
163 && other.Engine == Engine
-
164 && (other.SourceSHA == SourceSHA
-
165 || (other.SourceSHA != null
-
166 && SourceSHA != null
-
167 && other.SourceSHA.Equals(SourceSHA, StringComparison.OrdinalIgnoreCase)))
-
168 && other.CustomIteration == CustomIteration;
-
169#pragma warning restore CA1062 // Validate arguments of public methods
-
170 }
+

Definition at line 160 of file EngineVersion.cs.

+
161 {
+
162 // https://github.com/dotnet/roslyn-analyzers/issues/2875
+
163#pragma warning disable CA1062 // Validate arguments of public methods
+
164 return other!.Version?.Semver() == Version?.Semver()
+
165 && other.Engine == Engine
+
166 && (other.SourceSHA == SourceSHA
+
167 || (other.SourceSHA != null
+
168 && SourceSHA != null
+
169 && other.SourceSHA.Equals(SourceSHA, StringComparison.OrdinalIgnoreCase)))
+
170 && other.CustomIteration == CustomIteration;
+
171#pragma warning restore CA1062 // Validate arguments of public methods
+
172 }
-

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

+

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.DeleteVersion().

@@ -354,19 +354,19 @@ Here is the caller graph for this function:
-

Definition at line 124 of file EngineVersion.cs.

-
125 {
-
126 if (input == null)
-
127 throw new ArgumentNullException(nameof(input));
-
128
-
129 if (TryParse(input, out var engineVersion))
-
130 return engineVersion!;
-
131
-
132 throw new InvalidOperationException($"Invalid engine version: {input}");
-
133 }
-
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
+

Definition at line 126 of file EngineVersion.cs.

+
127 {
+
128 if (input == null)
+
129 throw new ArgumentNullException(nameof(input));
+
130
+
131 if (TryParse(input, out var engineVersion))
+
132 return engineVersion!;
+
133
+
134 throw new InvalidOperationException($"Invalid engine version: {input}");
+
135 }
+
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
-

References Tgstation.Server.Api.Models.EngineVersion.TryParse().

+

References Tgstation.Server.Api.Models.EngineVersion.TryParse().

Referenced by Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.Invoke().

@@ -409,30 +409,30 @@ Here is the caller graph for this function:

-

Definition at line 177 of file EngineVersion.cs.

-
178 {
-
179 var isByond = Engine == EngineType.Byond;
-
180
-
181 // BYOND encodes differently for backwards compatibility
-
182 var enginePrefix = !isByond
-
183 ? $"{Engine}-"
-
184 : String.Empty;
-
185 var displayedVersion = isByond
-
186 ? (CustomIteration.HasValue
-
187 ? new Version(Version!.Major, Version.Minor, CustomIteration.Value)
-
188 : Version!).ToString()
-
189 : SourceSHA;
-
190 var displayedCustomIteration = !isByond && CustomIteration.HasValue
-
191 ? $"-{CustomIteration}"
-
192 : String.Empty;
-
193 return $"{enginePrefix}{displayedVersion}{displayedCustomIteration}";
-
194 }
- +

Definition at line 179 of file EngineVersion.cs.

+
180 {
+
181 var isByond = Engine == EngineType.Byond;
+
182
+
183 // BYOND encodes differently for backwards compatibility
+
184 var enginePrefix = !isByond
+
185 ? $"{Engine}-"
+
186 : String.Empty;
+
187 var displayedVersion = isByond
+
188 ? (CustomIteration.HasValue
+
189 ? new Version(Version!.Major, Version.Minor, CustomIteration.Value)
+
190 : Version!).ToString()
+
191 : SourceSHA;
+
192 var displayedCustomIteration = !isByond && CustomIteration.HasValue
+
193 ? $"-{CustomIteration}"
+
194 : String.Empty;
+
195 return $"{enginePrefix}{displayedVersion}{displayedCustomIteration}";
+
196 }
+
EngineType
The type of engine the codebase is using.
Definition EngineType.cs:7
-

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.Version.

+

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.Version.

-

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.ChangeVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.DeleteVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.InstallVersionFiles(), Tgstation.Server.Host.Components.Deployment.DreamMaker.RunCompileJob(), Tgstation.Server.Host.Components.Chat.Providers.IrcProvider.SendUpdateMessage(), Tgstation.Server.Host.Components.Engine.EngineManager.StartAsync(), and Tgstation.Server.Api.Models.EngineVersion.ToString().

+

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.ChangeVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.DeleteVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.InstallVersionFiles(), Tgstation.Server.Host.Components.Deployment.DreamMaker.RunCompileJob(), Tgstation.Server.Host.Components.Chat.Providers.IrcProvider.SendUpdateMessage(), Tgstation.Server.Host.Components.Engine.EngineManager.StartAsync(), and Tgstation.Server.Api.Models.EngineVersion.ToString().

Here is the call graph for this function:
@@ -529,78 +529,78 @@ Here is the caller graph for this function:
Returns
true if parsing was successful, false otherwise.
-

Definition at line 51 of file EngineVersion.cs.

-
52 {
-
53 if (input == null)
-
54 throw new ArgumentNullException(nameof(input));
-
55
-
56 var splits = input.Split(DashChar, StringSplitOptions.RemoveEmptyEntries);
-
57 engineVersion = null;
-
58
-
59 if (splits.Length > 3)
-
60 return false;
-
61
-
62 EngineType engine;
-
63 var hasPrefix = splits.Length > 1;
-
64 if (hasPrefix)
-
65 {
-
66 if (!Enum.TryParse(splits[0], out engine))
-
67 return false;
-
68 }
-
69 else
-
70 engine = EngineType.Byond;
-
71
-
72 Version? version;
-
73 string? sha;
-
74 int? customRev = null;
-
75 if (engine == EngineType.Byond)
-
76 {
-
77 if (!Version.TryParse(splits.Last(), out version))
-
78 return false;
-
79
-
80 if (version.Build > 0)
-
81 {
-
82 customRev = version.Build;
-
83 version = new Version(version.Major, version.Minor);
-
84 }
-
85
-
86 sha = null;
-
87 }
-
88 else
-
89 {
-
90 Debug.Assert(engine == EngineType.OpenDream, "This does not support whatever ungodly new engine you've added");
-
91
-
92 var shaIndex = hasPrefix ? 1 : 0;
-
93 sha = splits[shaIndex];
-
94 if (sha.Length != Limits.MaximumCommitShaLength)
-
95 return false;
-
96
-
97 version = null;
+

Definition at line 53 of file EngineVersion.cs.

+
54 {
+
55 if (input == null)
+
56 throw new ArgumentNullException(nameof(input));
+
57
+
58 var splits = input.Split(DashChar, StringSplitOptions.RemoveEmptyEntries);
+
59 engineVersion = null;
+
60
+
61 if (splits.Length > 3)
+
62 return false;
+
63
+
64 EngineType engine;
+
65 var hasPrefix = splits.Length > 1;
+
66 if (hasPrefix)
+
67 {
+
68 if (!Enum.TryParse(splits[0], out engine))
+
69 return false;
+
70 }
+
71 else
+
72 engine = EngineType.Byond;
+
73
+
74 Version? version;
+
75 string? sha;
+
76 int? customRev = null;
+
77 if (engine == EngineType.Byond)
+
78 {
+
79 if (!Version.TryParse(splits.Last(), out version))
+
80 return false;
+
81
+
82 if (version.Build > 0)
+
83 {
+
84 customRev = version.Build;
+
85 version = new Version(version.Major, version.Minor);
+
86 }
+
87
+
88 sha = null;
+
89 }
+
90 else
+
91 {
+
92 Debug.Assert(engine == EngineType.OpenDream, "This does not support whatever ungodly new engine you've added");
+
93
+
94 var shaIndex = hasPrefix ? 1 : 0;
+
95 sha = splits[shaIndex];
+
96 if (sha.Length != Limits.MaximumCommitShaLength)
+
97 return false;
98
-
99 if (splits.Length - 1 > shaIndex)
-
100 {
-
101 if (!Int32.TryParse(splits.Last(), out var customRevResult))
-
102 return false;
-
103
-
104 customRev = customRevResult;
-
105 }
-
106 }
-
107
-
108 engineVersion = new EngineVersion
-
109 {
-
110 Engine = engine,
-
111 Version = version,
-
112 SourceSHA = sha,
-
113 CustomIteration = customRev,
-
114 };
-
115 return true;
-
116 }
-
EngineVersion()
Initializes a new instance of the EngineVersion class.
+
99 version = null;
+
100
+
101 if (splits.Length - 1 > shaIndex)
+
102 {
+
103 if (!Int32.TryParse(splits.Last(), out var customRevResult))
+
104 return false;
+
105
+
106 customRev = customRevResult;
+
107 }
+
108 }
+
109
+
110 engineVersion = new EngineVersion
+
111 {
+
112 Engine = engine,
+
113 Version = version,
+
114 SourceSHA = sha,
+
115 CustomIteration = customRev,
+
116 };
+
117 return true;
+
118 }
+
EngineVersion()
Initializes a new instance of the EngineVersion class.
static readonly char[] DashChar
An array of a single '-' char.
-

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.DashChar, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.Limits.MaximumCommitShaLength, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

+

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.DashChar, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Api.Models.Limits.MaximumCommitShaLength, Tgstation.Server.Api.Models.EngineVersion.SourceSHA, and Tgstation.Server.Api.Models.EngineVersion.Version.

-

Referenced by Tgstation.Server.Host.Components.Deployment.DmbFactory.FromCompileJobInternal(), Tgstation.Server.Api.Models.EngineVersion.Parse(), and Tgstation.Server.Host.Components.Engine.EngineManager.StartAsync().

+

Referenced by Tgstation.Server.Host.Components.Deployment.DmbFactory.FromCompileJobInternal(), Tgstation.Server.Api.Models.EngineVersion.Parse(), and Tgstation.Server.Host.Components.Engine.EngineManager.StartAsync().

Here is the caller graph for this function:
@@ -655,7 +655,7 @@ Here is the caller graph for this function:

Definition at line 18 of file EngineVersion.cs.

-

Referenced by Tgstation.Server.Api.Models.EngineVersion.TryParse().

+

Referenced by Tgstation.Server.Api.Models.EngineVersion.TryParse().

@@ -682,10 +682,10 @@ Here is the caller graph for this function:

The revision of the custom build.

-

Definition at line 43 of file EngineVersion.cs.

-
43{ get; set; }
+

Definition at line 45 of file EngineVersion.cs.

+
45{ get; set; }
-

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.Invoke(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

+

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.Invoke(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

@@ -714,7 +714,7 @@ Here is the caller graph for this function:

Definition at line 24 of file EngineVersion.cs.

24{ get; set; }
-

Referenced by Tgstation.Server.Host.Components.Watchdog.WindowsWatchdog.ApplyInitialDmb(), Tgstation.Server.Host.Components.Engine.ByondInstallation.ByondInstallation(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.CanUseSwappableDmbProvider(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ChangeSettings(), Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.DelegateCall< TReturn >(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.Invoke(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), Tgstation.Server.Host.Components.Engine.OpenDreamInstallation.OpenDreamInstallation(), Tgstation.Server.Host.Components.Session.SessionController.ProcessBridgeCommand(), Tgstation.Server.Host.Components.Chat.Providers.IrcProvider.SendUpdateMessage(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

+

Referenced by Tgstation.Server.Host.Components.Watchdog.WindowsWatchdog.ApplyInitialDmb(), Tgstation.Server.Host.Components.Engine.ByondInstallation.ByondInstallation(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.CanUseSwappableDmbProvider(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ChangeSettings(), Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.Components.Engine.DelegatingEngineInstaller.DelegateCall< TReturn >(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.Invoke(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), Tgstation.Server.Host.Components.Engine.OpenDreamInstallation.OpenDreamInstallation(), Tgstation.Server.Host.Components.Session.SessionController.ProcessBridgeCommand(), Tgstation.Server.Host.Components.Chat.Providers.IrcProvider.SendUpdateMessage(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

@@ -739,11 +739,12 @@ Here is the caller graph for this function:

The git commit SHA of the engine. Currently only valid when Engine is EngineType.OpenDream.

+

caa1e1f400c8b6a535e03cff28cf57f919e9378c

-

Definition at line 37 of file EngineVersion.cs.

-
37{ get; set; }
+

Definition at line 39 of file EngineVersion.cs.

+
39{ get; set; }
-

Referenced by Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

+

Referenced by Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Api.Models.EngineVersion.TryParse().

@@ -768,11 +769,12 @@ Here is the caller graph for this function:

The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.

+

516.1651.0

-

Definition at line 30 of file EngineVersion.cs.

-
30{ get; set; }
+

Definition at line 31 of file EngineVersion.cs.

+
31{ get; set; }
-

Referenced by Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.AddDreamDaemonToFirewall(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.CreateInstallation(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.GetDownloadZipUrl(), Tgstation.Server.Host.Components.Engine.PosixByondInstaller.Install(), Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Api.Models.EngineVersion.TryParse(), and Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.UpgradeInstallation().

+

Referenced by Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.AddDreamDaemonToFirewall(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.CreateInstallation(), Tgstation.Server.Api.Models.EngineVersion.EngineVersion(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.GetDownloadZipUrl(), Tgstation.Server.Host.Components.Engine.PosixByondInstaller.Install(), Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Api.Models.EngineVersion.TryParse(), and Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.UpgradeInstallation().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html index 504bf6f476..d8a65d04cc 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_entity_id.html @@ -188,11 +188,12 @@ Properties

The ID of the entity.

+

1

-

Definition at line 13 of file EntityId.cs.

-
13{ get; set; }
+

Definition at line 14 of file EntityId.cs.

+
14{ get; set; }
-

Referenced by Tgstation.Server.Host.Authority.LoginAuthority.AttemptLogin(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.BeforeApplyDmb(), Tgstation.Server.Host.Jobs.JobService.CancelJob(), Tgstation.Server.Host.Controllers.ChatController.Create(), Tgstation.Server.Host.Controllers.RepositoryController.Create(), Tgstation.Server.Client.InstanceManagerClient.CreateClient(), Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.CreateLock(), Tgstation.Server.Api.Models.UserName.CreateUserName< TResultType >(), Tgstation.Server.Host.Controllers.RepositoryController.Delete(), Tgstation.Server.Host.Controllers.InstancePermissionSetController.Delete(), Tgstation.Server.Host.Controllers.JobController.Delete(), Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.DeploymentLockManager(), Tgstation.Server.Host.Components.Deployment.DmbFactory.FromCompileJobInternal(), Tgstation.Server.Host.Authority.UserAuthority.GetId(), Tgstation.Server.Host.Controllers.ChatController.GetId(), Tgstation.Server.Host.Controllers.InstancePermissionSetController.GetId(), Tgstation.Server.Host.Controllers.JobController.GetId(), Tgstation.Server.Host.Controllers.UserController.GetId(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.HandleNewDmbAvailable(), Tgstation.Server.Host.Controllers.ApiController.HookExecuteAction(), Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.InitController(), Tgstation.Server.Client.Components.InstanceClient.InstanceClient(), Tgstation.Server.Host.Models.Job.Job(), Tgstation.Server.Host.Models.Job.Job(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), Tgstation.Server.Host.Controllers.ChatController.List(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.PerformDmbSwap(), Tgstation.Server.Host.Controllers.DreamMakerController.Read(), Tgstation.Server.Host.Controllers.RepositoryController.Read(), Tgstation.Server.Client.Components.ConfigurationClient.Read(), Tgstation.Server.Host.Controllers.DreamDaemonController.ReadImpl(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.Reattach(), Tgstation.Server.Host.Controllers.RepositoryController.Reclone(), Tgstation.Server.Host.Jobs.JobService.RegisterOperation(), Tgstation.Server.Host.Jobs.JobService.RunJob(), Tgstation.Server.Client.Components.EngineClient.SetActiveVersion(), Tgstation.Server.Host.GraphQL.Mutations.UserMutations.SetCurrentOAuthConnections(), Tgstation.Server.Host.GraphQL.Mutations.UserMutations.SetCurrentUserPassword(), Tgstation.Server.Host.Models.ChatBot.ToApi(), Tgstation.Server.Host.Models.CompileJob.ToApi(), Tgstation.Server.Host.Models.Instance.ToApi(), Tgstation.Server.Host.Models.Job.ToApi(), Tgstation.Server.Host.Models.UserGroup.ToApi(), Tgstation.Server.Host.Controllers.ChatController.Update(), Tgstation.Server.Host.Controllers.DreamDaemonController.Update(), Tgstation.Server.Host.Controllers.DreamMakerController.Update(), Tgstation.Server.Host.Controllers.EngineController.Update(), Tgstation.Server.Host.Controllers.InstancePermissionSetController.Update(), Tgstation.Server.Host.Controllers.RepositoryController.Update(), Tgstation.Server.Host.Jobs.JobsHubGroupMapper.UserDisabled(), and Tgstation.Server.Client.Components.ConfigurationClient.Write().

+

Referenced by Tgstation.Server.Host.Authority.LoginAuthority.AttemptLogin(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.BeforeApplyDmb(), Tgstation.Server.Host.Jobs.JobService.CancelJob(), Tgstation.Server.Host.Controllers.ChatController.Create(), Tgstation.Server.Host.Controllers.RepositoryController.Create(), Tgstation.Server.Client.InstanceManagerClient.CreateClient(), Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.CreateLock(), Tgstation.Server.Api.Models.UserName.CreateUserName< TResultType >(), Tgstation.Server.Host.Controllers.RepositoryController.Delete(), Tgstation.Server.Host.Controllers.InstancePermissionSetController.Delete(), Tgstation.Server.Host.Controllers.JobController.Delete(), Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.DeploymentLockManager(), Tgstation.Server.Host.Components.Deployment.DmbFactory.FromCompileJobInternal(), Tgstation.Server.Host.Authority.UserAuthority.GetId(), Tgstation.Server.Host.Controllers.ChatController.GetId(), Tgstation.Server.Host.Controllers.InstancePermissionSetController.GetId(), Tgstation.Server.Host.Controllers.JobController.GetId(), Tgstation.Server.Host.Controllers.UserController.GetId(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.HandleNewDmbAvailable(), Tgstation.Server.Host.Controllers.ApiController.HookExecuteAction(), Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.InitController(), Tgstation.Server.Client.Components.InstanceClient.InstanceClient(), Tgstation.Server.Host.Models.Job.Job(), Tgstation.Server.Host.Models.Job.Job(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), Tgstation.Server.Host.Controllers.ChatController.List(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.PerformDmbSwap(), Tgstation.Server.Host.Controllers.DreamMakerController.Read(), Tgstation.Server.Host.Controllers.RepositoryController.Read(), Tgstation.Server.Client.Components.ConfigurationClient.Read(), Tgstation.Server.Host.Controllers.DreamDaemonController.ReadImpl(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.Reattach(), Tgstation.Server.Host.Controllers.RepositoryController.Reclone(), Tgstation.Server.Host.Jobs.JobService.RegisterOperation(), Tgstation.Server.Host.Jobs.JobService.RunJob(), Tgstation.Server.Client.Components.EngineClient.SetActiveVersion(), Tgstation.Server.Host.GraphQL.Mutations.UserMutations.SetCurrentOAuthConnections(), Tgstation.Server.Host.GraphQL.Mutations.UserMutations.SetCurrentUserPassword(), Tgstation.Server.Host.Models.ChatBot.ToApi(), Tgstation.Server.Host.Models.CompileJob.ToApi(), Tgstation.Server.Host.Models.Instance.ToApi(), Tgstation.Server.Host.Models.Job.ToApi(), Tgstation.Server.Host.Models.UserGroup.ToApi(), Tgstation.Server.Host.Controllers.ChatController.Update(), Tgstation.Server.Host.Controllers.DreamDaemonController.Update(), Tgstation.Server.Host.Controllers.DreamMakerController.Update(), Tgstation.Server.Host.Controllers.EngineController.Update(), Tgstation.Server.Host.Controllers.InstancePermissionSetController.Update(), Tgstation.Server.Host.Controllers.RepositoryController.Update(), Tgstation.Server.Host.Jobs.JobsHubGroupMapper.UserDisabled(), and Tgstation.Server.Client.Components.ConfigurationClient.Write().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_bot_api_base.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_bot_api_base.html index 6b6e726e5f..9770c5dc98 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_bot_api_base.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_bot_api_base.html @@ -196,9 +196,9 @@ Properties
28 };
29 }
Tgstation.Server.Api.Models.Internal.ChatBotApiBase.Channels
ICollection< ChatChannel >? Channels
Channels the Discord bot should listen/announce in.
Definition ChatBotApiBase.cs:13
-
Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider
ChatProvider? Provider
The ChatProvider used for the connection.
Definition ChatBotSettings.cs:35
+
Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider
ChatProvider? Provider
The ChatProvider used for the connection.
Definition ChatBotSettings.cs:37
-

References Tgstation.Server.Api.Models.Internal.ChatBotApiBase.Channels, and Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider.

+

References Tgstation.Server.Api.Models.Internal.ChatBotApiBase.Channels, and Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider.

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_bot_settings.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_bot_settings.html index 81629beb7e..5c702c8464 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_bot_settings.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_bot_settings.html @@ -177,21 +177,21 @@ Properties

Get the ChatConnectionStringBuilder which maps to the ConnectionString.

Returns
A ChatConnectionStringBuilder for the ChatBotSettings.
-

Definition at line 50 of file ChatBotSettings.cs.

-
51 {
-
52 if (ConnectionString == null)
-
53 return null;
-
54 return Provider switch
-
55 {
-
56 ChatProvider.Discord => new DiscordConnectionStringBuilder(ConnectionString),
-
57 ChatProvider.Irc => new IrcConnectionStringBuilder(ConnectionString),
-
58 _ => throw new InvalidOperationException("Invalid Provider!"),
-
59 };
-
60 }
-
string? ConnectionString
The information used to connect to the Provider.
-
ChatProvider? Provider
The ChatProvider used for the connection.
+

Definition at line 52 of file ChatBotSettings.cs.

+
53 {
+
54 if (ConnectionString == null)
+
55 return null;
+
56 return Provider switch
+
57 {
+
58 ChatProvider.Discord => new DiscordConnectionStringBuilder(ConnectionString),
+
59 ChatProvider.Irc => new IrcConnectionStringBuilder(ConnectionString),
+
60 _ => throw new InvalidOperationException("Invalid Provider!"),
+
61 };
+
62 }
+
string? ConnectionString
The information used to connect to the Provider.
+
ChatProvider? Provider
The ChatProvider used for the connection.
-

References Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString, and Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider.

+

References Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString, and Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider.

@@ -219,12 +219,12 @@ Properties -

Definition at line 66 of file ChatBotSettings.cs.

-
67 {
-
68 ConnectionString = stringBuilder?.ToString() ?? throw new ArgumentNullException(nameof(stringBuilder));
-
69 }
+

Definition at line 68 of file ChatBotSettings.cs.

+
69 {
+
70 ConnectionString = stringBuilder?.ToString() ?? throw new ArgumentNullException(nameof(stringBuilder));
+
71 }
-

References Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString, and Tgstation.Server.Api.Models.Internal.ChatConnectionStringBuilder.ToString().

+

References Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString, and Tgstation.Server.Api.Models.Internal.ChatConnectionStringBuilder.ToString().

Here is the call graph for this function:
@@ -260,9 +260,10 @@ Here is the call graph for this function:

The maximum number of ChatChannels the ChatBotSettings may contain.

+

5

-

Definition at line 27 of file ChatBotSettings.cs.

-
27{ get; set; }
+

Definition at line 29 of file ChatBotSettings.cs.

+
29{ get; set; }

Referenced by Tgstation.Server.Host.Models.ChatBot.ToApi().

@@ -290,10 +291,10 @@ Here is the call graph for this function:

The information used to connect to the Provider.

-

Definition at line 44 of file ChatBotSettings.cs.

-
44{ get; set; }
+

Definition at line 46 of file ChatBotSettings.cs.

+
46{ get; set; }
-

Referenced by Tgstation.Server.Api.Models.Internal.ChatBotSettings.CreateConnectionStringBuilder(), Tgstation.Server.Host.Database.MySqlDatabaseContext.OnModelCreating(), Tgstation.Server.Api.Models.Internal.ChatBotSettings.SetConnectionStringBuilder(), and Tgstation.Server.Host.Models.ChatBot.ToApi().

+

Referenced by Tgstation.Server.Api.Models.Internal.ChatBotSettings.CreateConnectionStringBuilder(), Tgstation.Server.Host.Database.MySqlDatabaseContext.OnModelCreating(), Tgstation.Server.Api.Models.Internal.ChatBotSettings.SetConnectionStringBuilder(), and Tgstation.Server.Host.Models.ChatBot.ToApi().

@@ -348,10 +349,10 @@ Here is the call graph for this function:

The ChatProvider used for the connection.

-

Definition at line 35 of file ChatBotSettings.cs.

-
35{ get; set; }
+

Definition at line 37 of file ChatBotSettings.cs.

+
37{ get; set; }
-

Referenced by Tgstation.Server.Api.Models.Internal.ChatBotSettings.CreateConnectionStringBuilder(), Tgstation.Server.Host.Models.ChatBot.ToApi(), and Tgstation.Server.Api.Models.Internal.ChatBotApiBase.ValidateProviderChannelTypes().

+

Referenced by Tgstation.Server.Api.Models.Internal.ChatBotSettings.CreateConnectionStringBuilder(), Tgstation.Server.Host.Models.ChatBot.ToApi(), and Tgstation.Server.Api.Models.Internal.ChatBotApiBase.ValidateProviderChannelTypes().

@@ -376,9 +377,10 @@ Here is the call graph for this function:

The time interval in minutes the chat bot attempts to reconnect if Enabled and disconnected. Must not be zero.

+

60

-

Definition at line 21 of file ChatBotSettings.cs.

-
21{ get; set; }
+

Definition at line 22 of file ChatBotSettings.cs.

+
22{ get; set; }

Referenced by Tgstation.Server.Host.Models.ChatBot.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_channel_base.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_channel_base.html index 9a7b8dd299..4e436d0a25 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_channel_base.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_channel_base.html @@ -140,9 +140,10 @@ Properties

If the ChatChannel is an admin channel.

+

false

-

Definition at line 14 of file ChatChannelBase.cs.

-
14{ get; set; }
+

Definition at line 15 of file ChatChannelBase.cs.

+
15{ get; set; }

Referenced by Tgstation.Server.Host.Models.ChatChannel.ToApi().

@@ -170,8 +171,8 @@ Properties

If the ChatChannel received system messages.

-

Definition at line 32 of file ChatChannelBase.cs.

-
32{ get; set; }
+

Definition at line 35 of file ChatChannelBase.cs.

+
35{ get; set; }

Referenced by Tgstation.Server.Host.Models.ChatChannel.ToApi().

@@ -198,9 +199,10 @@ Properties

If the ChatChannel is an updates channel.

+

false

-

Definition at line 26 of file ChatChannelBase.cs.

-
26{ get; set; }
+

Definition at line 29 of file ChatChannelBase.cs.

+
29{ get; set; }

Referenced by Tgstation.Server.Host.Models.ChatChannel.ToApi().

@@ -227,9 +229,10 @@ Properties

If the ChatChannel is a watchdog channel.

+

false

-

Definition at line 20 of file ChatChannelBase.cs.

-
20{ get; set; }
+

Definition at line 22 of file ChatChannelBase.cs.

+
22{ get; set; }

Referenced by Tgstation.Server.Host.Models.ChatChannel.ToApi().

@@ -256,9 +259,10 @@ Properties

A custom tag users can define to group channels together.

+

system-channel-only

-

Definition at line 39 of file ChatChannelBase.cs.

-
39{ get; set; }
+

Definition at line 43 of file ChatChannelBase.cs.

+
43{ get; set; }

Referenced by Tgstation.Server.Host.Controllers.ChatController.ConvertApiChatChannel(), and Tgstation.Server.Host.Models.ChatChannel.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_connection_string_builder.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_connection_string_builder.html index 31a4446f79..22ab84f453 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_connection_string_builder.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_chat_connection_string_builder.html @@ -140,7 +140,7 @@ Properties

Gets the ChatBotSettings.ConnectionString associated with the ChatConnectionStringBuilder.

Returns
The ChatBotSettings.ConnectionString associated with the ChatConnectionStringBuilder.
-

Referenced by Tgstation.Server.Api.Models.Internal.ChatBotSettings.SetConnectionStringBuilder().

+

Referenced by Tgstation.Server.Api.Models.Internal.ChatBotSettings.SetConnectionStringBuilder().

Here is the caller graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_compile_job.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_compile_job.html index b48b2ebf5f..3f6c842ff2 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_compile_job.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_compile_job.html @@ -157,8 +157,8 @@ Properties

The Game folder the results were compiled into.

-

Definition at line 28 of file CompileJob.cs.

-
28{ get; set; }
+

Definition at line 29 of file CompileJob.cs.

+
29{ get; set; }

Referenced by Tgstation.Server.Host.Components.Deployment.DmbFactory.CleanRegisteredCompileJob(), and Tgstation.Server.Host.Models.CompileJob.ToApi().

@@ -185,9 +185,10 @@ Properties

The DMAPI Version.

+

7.3.0

-

Definition at line 41 of file CompileJob.cs.

-

The .dme file used for compilation.

+

tgstation.dme

-

Definition at line 16 of file CompileJob.cs.

-
16{ get; set; }
+

Definition at line 17 of file CompileJob.cs.

+
17{ get; set; }

Referenced by Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.HandleNewDmbAvailable(), and Tgstation.Server.Host.Models.CompileJob.ToApi().

@@ -244,8 +246,8 @@ Properties

The minimum DreamDaemonSecurity required to run the CompileJob's output.

-

Definition at line 34 of file CompileJob.cs.

-
34{ get; set; }
+

Definition at line 35 of file CompileJob.cs.

+
35{ get; set; }

Referenced by Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), and Tgstation.Server.Host.Models.CompileJob.ToApi().

@@ -273,8 +275,8 @@ Properties

Textual output of DM.

-

Definition at line 22 of file CompileJob.cs.

-
22{ get; set; }
+

Definition at line 23 of file CompileJob.cs.

+
23{ get; set; }

Referenced by Tgstation.Server.Host.Models.CompileJob.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html index 804a2aa45d..f0fba24cbb 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_api_base.html @@ -210,9 +210,10 @@ Additional Inherited Members

The last known count of connected players. Requires DreamDaemonLaunchParameters.HealthCheckSeconds to not be 0 and a game server interop version >= 5.10.0 to populate.

+

30

-

Definition at line 26 of file DreamDaemonApiBase.cs.

-
26{ get; set; }
+

Definition at line 28 of file DreamDaemonApiBase.cs.

+
28{ get; set; }
@@ -238,8 +239,8 @@ Additional Inherited Members

When the current server execution was started.

-

Definition at line 20 of file DreamDaemonApiBase.cs.

-
20{ get; set; }
+

Definition at line 21 of file DreamDaemonApiBase.cs.

+
21{ get; set; }
@@ -264,9 +265,10 @@ Additional Inherited Members

An incrementing ID for representing current server execution.

+

1

-

Definition at line 14 of file DreamDaemonApiBase.cs.

-
14{ get; set; }
+

Definition at line 15 of file DreamDaemonApiBase.cs.

+
15{ get; set; }
@@ -291,9 +293,10 @@ Additional Inherited Members

If the server is undergoing a soft reset. This may be automatically set by changes to other fields.

+

false

-

Definition at line 32 of file DreamDaemonApiBase.cs.

-
32{ get; set; }
+

Definition at line 35 of file DreamDaemonApiBase.cs.

+
35{ get; set; }
@@ -319,8 +322,8 @@ Additional Inherited Members

If the server is undergoing a soft shutdown.

-

Definition at line 38 of file DreamDaemonApiBase.cs.

-
38{ get; set; }
+

Definition at line 41 of file DreamDaemonApiBase.cs.

+
41{ get; set; }
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_launch_parameters.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_launch_parameters.html index b5b2598663..3dee1b78fe 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_launch_parameters.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_dream_daemon_launch_parameters.html @@ -195,35 +195,35 @@ Properties
Returns
true if they match, false otherwise.
-

Definition at line 121 of file DreamDaemonLaunchParameters.cs.

-
122 {
-
123 if (otherParameters == null)
-
124 throw new ArgumentNullException(nameof(otherParameters));
-
125
-
126 return AllowWebClient == otherParameters.AllowWebClient
-
127 && SecurityLevel == otherParameters.SecurityLevel
-
128 && Visibility == otherParameters.Visibility
-
129 && Port == otherParameters.Port
-
130 && (OpenDreamTopicPort == otherParameters.OpenDreamTopicPort || engineType != EngineType.OpenDream)
-
131 && TopicRequestTimeout == otherParameters.TopicRequestTimeout
-
132 && AdditionalParameters == otherParameters.AdditionalParameters
-
133 && StartProfiler == otherParameters.StartProfiler
-
134 && LogOutput == otherParameters.LogOutput
-
135 && MapThreads == otherParameters.MapThreads; // We intentionally don't check StartupTimeout, Minidumps, health check seconds, or health check dump as they don't matter in terms of the watchdog
-
136 }
-
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
-
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
-
ushort? OpenDreamTopicPort
The port used by EngineType.OpenDream for its topic port.
-
bool? LogOutput
If process output/error text should be logged.
-
uint? TopicRequestTimeout
The timeout for sending and receiving BYOND topics in milliseconds.
-
bool? AllowWebClient
If the BYOND web client can be used to connect to the game server. No-op for EngineType....
-
bool? StartProfiler
If -profile is passed in on the DreamDaemon command line. No-op for EngineType.OpenDream.
-
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
- -
uint? MapThreads
If DreamDaemon supports it, the value added as the -map-threads parameter. 0 uses the default BYOND v...
+

Definition at line 129 of file DreamDaemonLaunchParameters.cs.

+
130 {
+
131 if (otherParameters == null)
+
132 throw new ArgumentNullException(nameof(otherParameters));
+
133
+
134 return AllowWebClient == otherParameters.AllowWebClient
+
135 && SecurityLevel == otherParameters.SecurityLevel
+
136 && Visibility == otherParameters.Visibility
+
137 && Port == otherParameters.Port
+
138 && (OpenDreamTopicPort == otherParameters.OpenDreamTopicPort || engineType != EngineType.OpenDream)
+
139 && TopicRequestTimeout == otherParameters.TopicRequestTimeout
+
140 && AdditionalParameters == otherParameters.AdditionalParameters
+
141 && StartProfiler == otherParameters.StartProfiler
+
142 && LogOutput == otherParameters.LogOutput
+
143 && MapThreads == otherParameters.MapThreads; // We intentionally don't check StartupTimeout, Minidumps, health check seconds, or health check dump as they don't matter in terms of the watchdog
+
144 }
+
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
+
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
+
ushort? OpenDreamTopicPort
The port used by EngineType.OpenDream for its topic port.
+
bool? LogOutput
If process output/error text should be logged.
+
uint? TopicRequestTimeout
The timeout for sending and receiving BYOND topics in milliseconds.
+
bool? AllowWebClient
If the BYOND web client can be used to connect to the game server. No-op for EngineType....
+
bool? StartProfiler
If -profile is passed in on the DreamDaemon command line. No-op for EngineType.OpenDream.
+
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
+ +
uint? MapThreads
If DreamDaemon supports it, the value added as the -map-threads parameter. 0 uses the default BYOND v...
EngineType
The type of engine the codebase is using.
Definition EngineType.cs:7
-

References Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AdditionalParameters, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AllowWebClient, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.MapThreads, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.OpenDreamTopicPort, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartProfiler, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout, and Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility.

+

References Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AdditionalParameters, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AllowWebClient, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.MapThreads, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.OpenDreamTopicPort, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartProfiler, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout, and Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility.

@@ -250,10 +250,10 @@ Properties

Parameters string for DreamDaemon.

-

Definition at line 92 of file DreamDaemonLaunchParameters.cs.

-
@@ -278,11 +278,12 @@ Properties
@@ -308,8 +309,8 @@ Properties

If a process core dump should be created prior to restarting the watchdog due to health check failure.

-

Definition at line 76 of file DreamDaemonLaunchParameters.cs.

-
76{ get; set; }
+

Definition at line 83 of file DreamDaemonLaunchParameters.cs.

+
83{ get; set; }

Referenced by Tgstation.Server.Host.Components.Watchdog.WatchdogBase.HandleHealthCheck().

@@ -336,9 +337,10 @@ Properties

The number of seconds between each watchdog health check. 0 disables.

+

5

-

Definition at line 69 of file DreamDaemonLaunchParameters.cs.

- @@ -395,10 +397,10 @@ Properties

If DreamDaemon supports it, the value added as the -map-threads parameter. 0 uses the default BYOND value. No-op for EngineType.OpenDream.

-

Definition at line 106 of file DreamDaemonLaunchParameters.cs.

-
@@ -424,8 +426,8 @@ Properties

If minidumps should be taken instead of full dumps.

-

Definition at line 113 of file DreamDaemonLaunchParameters.cs.

-
113{ get; set; }
+

Definition at line 121 of file DreamDaemonLaunchParameters.cs.

+
121{ get; set; }
@@ -450,11 +452,12 @@ Properties

The port used by EngineType.OpenDream for its topic port.

+

2337

-

Definition at line 54 of file DreamDaemonLaunchParameters.cs.

-
@@ -479,11 +482,12 @@ Properties
@@ -508,11 +512,12 @@ Properties

The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.

+

1

-

Definition at line 39 of file DreamDaemonLaunchParameters.cs.

-
@@ -538,10 +543,10 @@ Properties

If -profile is passed in on the DreamDaemon command line. No-op for EngineType.OpenDream.

-

Definition at line 23 of file DreamDaemonLaunchParameters.cs.

-
23{ get; set; }
+

Definition at line 24 of file DreamDaemonLaunchParameters.cs.

+
24{ get; set; }
-

Referenced by Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.CanApplyWithoutReboot(), and Tgstation.Server.Host.Components.Engine.ByondInstallation.FormatServerArguments().

+

Referenced by Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.CanApplyWithoutReboot(), and Tgstation.Server.Host.Components.Engine.ByondInstallation.FormatServerArguments().

@@ -566,9 +571,10 @@ Properties

The DreamDaemon startup timeout in seconds.

+

5

-

Definition at line 62 of file DreamDaemonLaunchParameters.cs.

-
62{ get; set; }
+

Definition at line 68 of file DreamDaemonLaunchParameters.cs.

+
68{ get; set; }

Referenced by Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.HandleNormalReboot(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), and Tgstation.Server.Host.Components.Deployment.DreamMaker.RunCompileJob().

@@ -595,11 +601,12 @@ Properties

The timeout for sending and receiving BYOND topics in milliseconds.

+

500

-

Definition at line 84 of file DreamDaemonLaunchParameters.cs.

-
@@ -624,11 +631,12 @@ Properties

The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.

+

2

-

Definition at line 31 of file DreamDaemonLaunchParameters.cs.

-
31{ get; set; }
+

Definition at line 33 of file DreamDaemonLaunchParameters.cs.

+
33{ get; set; }
-

Referenced by Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.CanApplyWithoutReboot(), Tgstation.Server.Host.Components.Engine.ByondInstallation.FormatServerArguments(), and Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew().

+

Referenced by Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.CanApplyWithoutReboot(), Tgstation.Server.Host.Components.Engine.ByondInstallation.FormatServerArguments(), and Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_job.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_job.html index ec5b107e91..691beac6c3 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_job.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_job.html @@ -168,9 +168,10 @@ Properties

If the Job was cancelled.

+

false

-

Definition at line 54 of file Job.cs.

-
54{ get; set; }
+

Definition at line 56 of file Job.cs.

+
56{ get; set; }

Referenced by Tgstation.Server.Host.Jobs.JobService.RunJob(), and Tgstation.Server.Host.Models.Job.ToApi().

@@ -198,8 +199,8 @@ Properties

The Rights required to cancel the Job.

-

Definition at line 66 of file Job.cs.

-
66{ get; set; }
+

Definition at line 68 of file Job.cs.

+
68{ get; set; }

Referenced by Tgstation.Server.Host.Models.Job.Job(), and Tgstation.Server.Host.Models.Job.ToApi().

@@ -227,8 +228,8 @@ Properties

The RightsType of CancelRight if it can be cancelled.

-

Definition at line 60 of file Job.cs.

-
60{ get; set; }
+

Definition at line 62 of file Job.cs.

+
62{ get; set; }

Referenced by Tgstation.Server.Host.Models.Job.Job(), and Tgstation.Server.Host.Models.Job.ToApi().

@@ -256,9 +257,10 @@ Properties

English description of the Job.

May not match the System.ComponentModel.DescriptionAttribute listed on the Models.JobCode.

+

Installing and configuring important objects.

-

Definition at line 24 of file Job.cs.

-
24{ get; set; }
+

Definition at line 25 of file Job.cs.

+
25{ get; set; }

Referenced by Tgstation.Server.Host.Models.Job.Job(), Tgstation.Server.Host.Jobs.JobService.RegisterOperation(), and Tgstation.Server.Host.Models.Job.ToApi().

@@ -286,8 +288,8 @@ Properties

The Models.ErrorCode associated with the Job if any.

-

Definition at line 30 of file Job.cs.

-
30{ get; set; }
+

Definition at line 31 of file Job.cs.

+
31{ get; set; }

Referenced by Tgstation.Server.Host.Jobs.JobService.RunJob(), and Tgstation.Server.Host.Models.Job.ToApi().

@@ -315,8 +317,8 @@ Properties

Details of any exceptions caught during the Job.

-

Definition at line 36 of file Job.cs.

-
36{ get; set; }
+

Definition at line 37 of file Job.cs.

+
37{ get; set; }

Referenced by Tgstation.Server.Host.Jobs.JobService.RunJob(), and Tgstation.Server.Host.Models.Job.ToApi().

@@ -371,8 +373,8 @@ Properties

When the Job was started.

-

Definition at line 42 of file Job.cs.

-
42{ get; set; }
+

Definition at line 43 of file Job.cs.

+
43{ get; set; }

Referenced by Tgstation.Server.Host.Models.Job.ToApi().

@@ -400,8 +402,8 @@ Properties

When the Job stopped.

-

Definition at line 48 of file Job.cs.

-
48{ get; set; }
+

Definition at line 49 of file Job.cs.

+
49{ get; set; }

Referenced by Tgstation.Server.Host.Components.Deployment.DmbFactory.FromCompileJobInternal(), and Tgstation.Server.Host.Models.Job.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_server_information_base.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_server_information_base.html index f5f8fc674a..e33b280c42 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_server_information_base.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_server_information_base.html @@ -140,9 +140,10 @@ Properties

The maximum number of Instances allowed.

+

100

-

Definition at line 18 of file ServerInformationBase.cs.

-

Minimum length of database user passwords.

+

20

-

Definition at line 13 of file ServerInformationBase.cs.

-
13{ get; set; }
+

Definition at line 14 of file ServerInformationBase.cs.

+
14{ get; set; }

Referenced by Tgstation.Server.Host.Configuration.GeneralConfiguration.GeneralConfiguration(), and Tgstation.Server.Host.Controllers.ApiRootController.ServerInfo().

@@ -198,9 +200,10 @@ Properties

The maximum number of user groups allowed.

+

50

-

Definition at line 28 of file ServerInformationBase.cs.

-
28{ get; set; }
+

Definition at line 32 of file ServerInformationBase.cs.

+
32{ get; set; }

Referenced by Tgstation.Server.Host.Configuration.GeneralConfiguration.GeneralConfiguration(), and Tgstation.Server.Host.Controllers.ApiRootController.ServerInfo().

@@ -227,9 +230,10 @@ Properties

The maximum number of users allowed.

+

100

-

Definition at line 23 of file ServerInformationBase.cs.

-
23{ get; set; }
+

Definition at line 26 of file ServerInformationBase.cs.

+
26{ get; set; }

Referenced by Tgstation.Server.Host.Configuration.GeneralConfiguration.GeneralConfiguration(), and Tgstation.Server.Host.Controllers.ApiRootController.ServerInfo().

@@ -256,9 +260,10 @@ Properties

Limits the locations instances may be created or attached from.

+

["/home/tgstation-server/my-server-1", "/home/tgstation-server/my-server-2"]

-

Definition at line 34 of file ServerInformationBase.cs.

-
34{ get; set; }
+

Definition at line 39 of file ServerInformationBase.cs.

+
39{ get; set; }

Referenced by Tgstation.Server.Host.Controllers.InstanceController.Create(), and Tgstation.Server.Host.Controllers.ApiRootController.ServerInfo().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html index 5632b6cc92..03ce695c6f 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server.html @@ -152,9 +152,9 @@ Properties

Initializes a new instance of the SwarmServer class.

-

Definition at line 31 of file SwarmServer.cs.

-
32 {
-
33 }
+

Definition at line 32 of file SwarmServer.cs.

+
33 {
+
34 }
@@ -190,22 +190,22 @@ Properties -

Definition at line 39 of file SwarmServer.cs.

-
40 {
-
41 if (copy == null)
-
42 {
-
43 throw new ArgumentNullException(nameof(copy));
-
44 }
-
45
-
46 Address = copy.Address;
-
47 PublicAddress = copy.PublicAddress;
-
48 Identifier = copy.Identifier;
-
49 }
+

Definition at line 40 of file SwarmServer.cs.

+
41 {
+
42 if (copy == null)
+
43 {
+
44 throw new ArgumentNullException(nameof(copy));
+
45 }
+
46
+
47 Address = copy.Address;
+
48 PublicAddress = copy.PublicAddress;
+
49 Identifier = copy.Identifier;
+
50 }
virtual ? Uri PublicAddress
The address the swarm server can be publically accessed.
virtual ? Uri Address
The public address of the server.
-
string? Identifier
The server's identifier.
+
string? Identifier
The server's identifier.
-

References Tgstation.Server.Api.Models.Internal.SwarmServer.Address, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, and Tgstation.Server.Api.Models.Internal.SwarmServer.PublicAddress.

+

References Tgstation.Server.Api.Models.Internal.SwarmServer.Address, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, and Tgstation.Server.Api.Models.Internal.SwarmServer.PublicAddress.

@@ -235,7 +235,7 @@ Properties

Definition at line 15 of file SwarmServer.cs.

15{ get; set; }
-

Referenced by Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.RegisterNode(), Tgstation.Server.Host.GraphQL.Types.SwarmNode.SwarmNode(), and Tgstation.Server.Api.Models.Internal.SwarmServer.SwarmServer().

+

Referenced by Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.RegisterNode(), Tgstation.Server.Host.GraphQL.Types.SwarmNode.SwarmNode(), and Tgstation.Server.Api.Models.Internal.SwarmServer.SwarmServer().

@@ -260,11 +260,12 @@ Properties

The server's identifier.

+

myserver-us-east

-

Definition at line 26 of file SwarmServer.cs.

-
26{ get; set; }
+

Definition at line 27 of file SwarmServer.cs.

+
27{ get; set; }
-

Referenced by Tgstation.Server.Host.Swarm.SwarmService.CommitUpdate(), Tgstation.Server.Host.Controllers.InstanceController.Create(), Tgstation.Server.Host.Controllers.InstanceController.CreateDefaultInstance(), Tgstation.Server.Host.Controllers.InstanceController.Delete(), Tgstation.Server.Host.Utils.PortAllocator.GetAvailablePort(), Tgstation.Server.Host.Controllers.InstanceController.GetId(), Tgstation.Server.Host.Controllers.InstanceController.GrantPermissions(), Tgstation.Server.Host.Swarm.SwarmService.HealthCheckNodes(), Tgstation.Server.Host.Components.InstanceManager.Initialize(), Tgstation.Server.Host.Swarm.SwarmService.Initialize(), Tgstation.Server.Host.Controllers.InstanceController.List(), Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.PrepareUpdateImpl(), Tgstation.Server.Host.Swarm.SwarmService.RegisterNode(), Tgstation.Server.Host.Database.DatabaseSeeder.SanitizeDatabase(), Tgstation.Server.Host.Swarm.SwarmService.SendUpdatedServerListToNodes(), Tgstation.Server.Host.GraphQL.Types.SwarmNode.SwarmNode(), Tgstation.Server.Api.Models.Internal.SwarmServer.SwarmServer(), Tgstation.Server.Host.Swarm.SwarmService.SwarmService(), Tgstation.Server.Host.Controllers.InstanceController.Update(), Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseAdditionalRequestLoggingContext(), and Tgstation.Server.Host.Security.AuthenticationContextFactory.ValidateToken().

+

Referenced by Tgstation.Server.Host.Swarm.SwarmService.CommitUpdate(), Tgstation.Server.Host.Controllers.InstanceController.Create(), Tgstation.Server.Host.Controllers.InstanceController.CreateDefaultInstance(), Tgstation.Server.Host.Controllers.InstanceController.Delete(), Tgstation.Server.Host.Utils.PortAllocator.GetAvailablePort(), Tgstation.Server.Host.Controllers.InstanceController.GetId(), Tgstation.Server.Host.Controllers.InstanceController.GrantPermissions(), Tgstation.Server.Host.Swarm.SwarmService.HealthCheckNodes(), Tgstation.Server.Host.Components.InstanceManager.Initialize(), Tgstation.Server.Host.Swarm.SwarmService.Initialize(), Tgstation.Server.Host.Controllers.InstanceController.List(), Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.PrepareUpdateImpl(), Tgstation.Server.Host.Swarm.SwarmService.RegisterNode(), Tgstation.Server.Host.Database.DatabaseSeeder.SanitizeDatabase(), Tgstation.Server.Host.Swarm.SwarmService.SendUpdatedServerListToNodes(), Tgstation.Server.Host.GraphQL.Types.SwarmNode.SwarmNode(), Tgstation.Server.Api.Models.Internal.SwarmServer.SwarmServer(), Tgstation.Server.Host.Swarm.SwarmService.SwarmService(), Tgstation.Server.Host.Controllers.InstanceController.Update(), Tgstation.Server.Host.Extensions.ApplicationBuilderExtensions.UseAdditionalRequestLoggingContext(), and Tgstation.Server.Host.Security.AuthenticationContextFactory.ValidateToken().

@@ -293,7 +294,7 @@ Properties

Definition at line 20 of file SwarmServer.cs.

20{ get; set; }
-

Referenced by Tgstation.Server.Host.Swarm.SwarmService.RegisterNode(), Tgstation.Server.Host.GraphQL.Types.SwarmNode.SwarmNode(), and Tgstation.Server.Api.Models.Internal.SwarmServer.SwarmServer().

+

Referenced by Tgstation.Server.Host.Swarm.SwarmService.RegisterNode(), Tgstation.Server.Host.GraphQL.Types.SwarmNode.SwarmNode(), and Tgstation.Server.Api.Models.Internal.SwarmServer.SwarmServer().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server_information.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server_information.html index 1849539037..8694d91a77 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server_information.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_swarm_server_information.html @@ -164,9 +164,9 @@ Additional Inherited Members

Initializes a new instance of the SwarmServerInformation class.

-

Definition at line 18 of file SwarmServerInformation.cs.

-
19 {
-
20 }
+

Definition at line 19 of file SwarmServerInformation.cs.

+
20 {
+
21 }
@@ -194,14 +194,14 @@ Additional Inherited Members -

Definition at line 26 of file SwarmServerInformation.cs.

-
27 : base(copy)
-
28 {
-
29 Controller = copy.Controller;
-
30 }
+

Definition at line 27 of file SwarmServerInformation.cs.

+
28 : base(copy)
+
29 {
+
30 Controller = copy.Controller;
+
31 }
-

References Tgstation.Server.Api.Models.Internal.SwarmServerInformation.Controller.

+

References Tgstation.Server.Api.Models.Internal.SwarmServerInformation.Controller.

@@ -227,11 +227,12 @@ Additional Inherited Members
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_test_merge_api_base.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_test_merge_api_base.html index ec821efd09..f79df52bdd 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_test_merge_api_base.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_test_merge_api_base.html @@ -180,9 +180,10 @@ Additional Inherited Members

The ID of the TestMergeApiBase.

+

1

-

Definition at line 14 of file TestMergeApiBase.cs.

-
14{ get; set; }
+

Definition at line 15 of file TestMergeApiBase.cs.

+
15{ get; set; }

Referenced by Tgstation.Server.Host.Models.TestMerge.ToApi().

@@ -210,8 +211,8 @@ Additional Inherited Members

When the TestMergeApiBase was created.

-

Definition at line 20 of file TestMergeApiBase.cs.

-
20{ get; set; }
+

Definition at line 21 of file TestMergeApiBase.cs.

+
21{ get; set; }

Referenced by Tgstation.Server.Host.Models.TestMerge.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_test_merge_model_base.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_test_merge_model_base.html index 8e9aa9e0dc..d30e6dd878 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_test_merge_model_base.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_test_merge_model_base.html @@ -177,9 +177,9 @@ Properties

Initializes a new instance of the TestMergeModelBase class.

-

Definition at line 40 of file TestMergeModelBase.cs.

-
41 {
-
42 }
+

Definition at line 44 of file TestMergeModelBase.cs.

+
45 {
+
46 }
@@ -215,27 +215,27 @@ Properties -

Definition at line 48 of file TestMergeModelBase.cs.

-
49 {
-
50 if (copy == null)
-
51 throw new ArgumentNullException(nameof(copy));
-
52 Author = copy.Author;
-
53 BodyAtMerge = copy.BodyAtMerge;
-
54 Comment = copy.Comment;
-
55 Number = copy.Number;
-
56 TargetCommitSha = copy.TargetCommitSha;
-
57 TitleAtMerge = copy.TitleAtMerge;
-
58 Url = copy.Url;
-
59 }
- -
string? BodyAtMerge
The body of the test merge source.
-
string? Author
The author of the test merge source.
-
string? TitleAtMerge
The title of the test merge source.
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
-
string? Comment
Optional comment about the test.
-
int Number
The number of the test merge source.
+

Definition at line 52 of file TestMergeModelBase.cs.

+
53 {
+
54 if (copy == null)
+
55 throw new ArgumentNullException(nameof(copy));
+
56 Author = copy.Author;
+
57 BodyAtMerge = copy.BodyAtMerge;
+
58 Comment = copy.Comment;
+
59 Number = copy.Number;
+
60 TargetCommitSha = copy.TargetCommitSha;
+
61 TitleAtMerge = copy.TitleAtMerge;
+
62 Url = copy.Url;
+
63 }
+ +
string? BodyAtMerge
The body of the test merge source.
+
string? Author
The author of the test merge source.
+
string? TitleAtMerge
The title of the test merge source.
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
string? Comment
Optional comment about the test.
+
int Number
The number of the test merge source.
-

References Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Author, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.BodyAtMerge, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Api.Models.TestMergeParameters.Number, Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TitleAtMerge, and Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Url.

+

References Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Author, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.BodyAtMerge, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Api.Models.TestMergeParameters.Number, Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TitleAtMerge, and Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Url.

@@ -261,11 +261,12 @@ Properties
@@ -290,11 +291,13 @@ Properties

The body of the test merge source.

+

# GitHub markdown
+\rI assume?

-

Definition at line 21 of file TestMergeModelBase.cs.

-
@@ -319,11 +322,12 @@ Properties

The title of the test merge source.

+

Fixes and Breaks everything

-

Definition at line 15 of file TestMergeModelBase.cs.

-
@@ -348,11 +352,12 @@ Properties

The URL of the test merge source.

+

https://github.com/tgstation/tgstation/pull/31026

-

Definition at line 28 of file TestMergeModelBase.cs.

-
28{ get; set; }
+

Definition at line 31 of file TestMergeModelBase.cs.

+
31{ get; set; }
-

Referenced by Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TestMergeModelBase(), and Tgstation.Server.Host.Models.TestMerge.ToApi().

+

Referenced by Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TestMergeModelBase(), and Tgstation.Server.Host.Models.TestMerge.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_update_information.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_update_information.html index b9cb0ef2dc..03596b48be 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_update_information.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_internal_1_1_update_information.html @@ -130,8 +130,8 @@ Properties

This response is cached. This field indicates the DateTimeOffset the UpdateInformation was generated.

-

Definition at line 18 of file UpdateInformation.cs.

-
18{ get; set; }
+

Definition at line 19 of file UpdateInformation.cs.

+
19{ get; set; }
@@ -156,9 +156,10 @@ Properties

The latest available version of the Tgstation.Server.Host assembly from the upstream repository. If Version.Major is less than 4 the update cannot be applied due to API changes.

+

1.0.0

-

Definition at line 13 of file UpdateInformation.cs.

-
13{ get; set; }
+

Definition at line 14 of file UpdateInformation.cs.

+
14{ get; set; }
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_limits.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_limits.html index abb64b2057..327c632edd 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_limits.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_limits.html @@ -167,7 +167,7 @@ Static Public Attributes

Definition at line 28 of file Limits.cs.

-

Referenced by Tgstation.Server.Api.Models.EngineVersion.TryParse(), and Tgstation.Server.Host.Controllers.EngineController.ValidateEngineVersion().

+

Referenced by Tgstation.Server.Api.Models.EngineVersion.TryParse(), and Tgstation.Server.Host.Controllers.EngineController.ValidateEngineVersion().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_named_entity.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_named_entity.html index a55e7324fc..ec30ee0bbf 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_named_entity.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_named_entity.html @@ -186,9 +186,10 @@ Properties

The name of the entity represented by the NamedEntity.

+

MyThingyName

-

Definition at line 16 of file NamedEntity.cs.

-
16{ get; set; }
+

Definition at line 17 of file NamedEntity.cs.

+
17{ get; set; }

Referenced by Tgstation.Server.Host.Controllers.ChatController.Create(), Tgstation.Server.Host.Database.MySqlDatabaseContext.OnModelCreating(), Tgstation.Server.Host.Models.ChatBot.ToApi(), Tgstation.Server.Host.Models.Instance.ToApi(), and Tgstation.Server.Host.Models.UserGroup.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request.html index 3f1e4e9287..29763738df 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_1_1_server_update_request.html @@ -119,9 +119,10 @@ Properties

Changes the version of tgstation-server to the given version from the upstream repository.

+

6.12.3

-

Definition at line 14 of file ServerUpdateRequest.cs.

-
14{ get; set; }
+

Definition at line 15 of file ServerUpdateRequest.cs.

+
15{ get; set; }
@@ -147,8 +148,8 @@ Properties

If the user will provide the server update package .zip file via file transfer as opposed to TGS retrieving it from GitHub.

-

Definition at line 19 of file ServerUpdateRequest.cs.

-
19{ get; set; }
+

Definition at line 20 of file ServerUpdateRequest.cs.

+
20{ get; set; }

Referenced by Tgstation.Server.Client.AdministrationClient.Update().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_administration_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_administration_response.html index 224de5a607..6658c506b5 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_administration_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_administration_response.html @@ -143,9 +143,10 @@ Properties

The GitHub repository the server is built to receive updates from.

+

https://github.com/tgstation/tgstation

-

Definition at line 15 of file AdministrationResponse.cs.

-
15{ get; set; }
+

Definition at line 16 of file AdministrationResponse.cs.

+
16{ get; set; }
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_dream_daemon_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_dream_daemon_response.html index 5d73f7b3a6..e5f871f818 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_dream_daemon_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_dream_daemon_response.html @@ -265,9 +265,10 @@ Additional Inherited Members

The webclient status the running DreamDaemonResponse instance is set to.

+

false

-

Definition at line 61 of file DreamDaemonResponse.cs.

-
61{ get; set; }
+

Definition at line 67 of file DreamDaemonResponse.cs.

+
67{ get; set; }
@@ -292,9 +293,10 @@ Additional Inherited Members

The port the running DreamDaemonResponse instance is set to.

+

1337

-

Definition at line 49 of file DreamDaemonResponse.cs.

-
49{ get; set; }
+

Definition at line 53 of file DreamDaemonResponse.cs.

+
53{ get; set; }
@@ -319,9 +321,10 @@ Additional Inherited Members

The current DreamDaemonSecurity. May be upgraded. due to requirements of ActiveCompileJob.

+

1

-

Definition at line 36 of file DreamDaemonResponse.cs.

-
36{ get; set; }
+

Definition at line 38 of file DreamDaemonResponse.cs.

+
38{ get; set; }
@@ -346,9 +349,10 @@ Additional Inherited Members

The EngineType.OpenDream topic port the running DreamDaemonResponse instance is set to.

+

3000

-

Definition at line 55 of file DreamDaemonResponse.cs.

-
55{ get; set; }
+

Definition at line 60 of file DreamDaemonResponse.cs.

+
60{ get; set; }
@@ -373,9 +377,10 @@ Additional Inherited Members

The current DreamDaemonVisibility.

+

2

-

Definition at line 43 of file DreamDaemonResponse.cs.

-
43{ get; set; }
+

Definition at line 46 of file DreamDaemonResponse.cs.

+
46{ get; set; }
@@ -400,9 +405,10 @@ Additional Inherited Members

The amount of RAM in use by the game server in bytes.

+

1073741824

-

Definition at line 67 of file DreamDaemonResponse.cs.

-
67{ get; set; }
+

Definition at line 74 of file DreamDaemonResponse.cs.

+
74{ get; set; }
@@ -454,9 +460,10 @@ Additional Inherited Members

The current WatchdogStatus.

+

2

-

Definition at line 29 of file DreamDaemonResponse.cs.

-
29{ get; set; }
+

Definition at line 30 of file DreamDaemonResponse.cs.

+
30{ get; set; }
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html index e900b7417f..309f2979a4 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html @@ -100,7 +100,7 @@ Properties  The version of the API the server is using.
  string? Message [get, set] - A human readable description of the error.
+ A human-readable description of the error.
  string? AdditionalData [get, set]  Additional data associated with the error message.
@@ -131,9 +131,9 @@ Properties

Initializes a new instance of the ErrorMessageResponse class.

-

Definition at line 39 of file ErrorMessageResponse.cs.

-
40 {
-
41 }
+

Definition at line 42 of file ErrorMessageResponse.cs.

+
43 {
+
44 }
@@ -161,17 +161,17 @@ Properties -

Definition at line 47 of file ErrorMessageResponse.cs.

-
48 {
-
49 ErrorCode = errorCode;
-
50 Message = errorCode.Describe();
-
51 ServerApiVersion = ApiHeaders.Version;
-
52 }
-
Version? ServerApiVersion
The version of the API the server is using.
-
string? Message
A human readable description of the error.
-
ErrorCode ErrorCode
The ErrorCode of the ErrorMessageResponse.
+

Definition at line 50 of file ErrorMessageResponse.cs.

+
51 {
+
52 ErrorCode = errorCode;
+
53 Message = errorCode.Describe();
+
54 ServerApiVersion = ApiHeaders.Version;
+
55 }
+
Version? ServerApiVersion
The version of the API the server is using.
+
string? Message
A human-readable description of the error.
+
ErrorCode ErrorCode
The ErrorCode of the ErrorMessageResponse.
-

References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.Message, Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ServerApiVersion, and Tgstation.Server.Api.ApiHeaders.Version.

+

References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.Message, Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ServerApiVersion, and Tgstation.Server.Api.ApiHeaders.Version.

@@ -197,9 +197,10 @@ Properties

Additional data associated with the error message.

+

Error at thing.app.dependency.class.function in line 32

-

Definition at line 27 of file ErrorMessageResponse.cs.

-
27{ get; set; }
+

Definition at line 30 of file ErrorMessageResponse.cs.

+
30{ get; set; }

Referenced by Tgstation.Server.Client.ApiException.ApiException(), and Tgstation.Server.Host.GraphQL.ErrorMessageException.ErrorMessageException().

@@ -227,8 +228,8 @@ Properties

The ErrorCode of the ErrorMessageResponse.

-

Definition at line 34 of file ErrorMessageResponse.cs.

-
34{ get; set; }
+

Definition at line 37 of file ErrorMessageResponse.cs.

+
37{ get; set; }

Referenced by Tgstation.Server.Client.ApiException.ApiException().

@@ -254,12 +255,13 @@ Properties
-

A human readable description of the error.

+

A human-readable description of the error.

+

Oopsie woopsie, we did a fucky wucky!

-

Definition at line 21 of file ErrorMessageResponse.cs.

-
@@ -284,11 +286,12 @@ Properties

The version of the API the server is using.

+

9.3.0

-

Definition at line 16 of file ErrorMessageResponse.cs.

-
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_file_ticket_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_file_ticket_response.html index 8d2c6a0b44..94406bfba6 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_file_ticket_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_file_ticket_response.html @@ -136,7 +136,7 @@ Properties

Definition at line 11 of file FileTicketResponse.cs.

11{ get; set; }
-

Referenced by Tgstation.Server.Host.Components.StaticFiles.Configuration.Read(), Tgstation.Server.Api.Models.Response.ServerUpdateResponse.ServerUpdateResponse(), and Tgstation.Server.Host.Components.StaticFiles.Configuration.Write().

+

Referenced by Tgstation.Server.Host.Components.StaticFiles.Configuration.Read(), Tgstation.Server.Api.Models.Response.ServerUpdateResponse.ServerUpdateResponse(), and Tgstation.Server.Host.Components.StaticFiles.Configuration.Write().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_job_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_job_response.html index a9fa06c540..531a8ce5c3 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_job_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_job_response.html @@ -123,7 +123,7 @@ Properties  Optional progress between 0 and 100 inclusive.
  string? Stage [get, set] - Optional description of the job's current .
+ Optional description of the job's current progress.
  - Properties inherited from Tgstation.Server.Api.Models.Internal.Job JobCodeJobCode [get, set] @@ -185,8 +185,8 @@ Properties

The UserResponse that cancelled the job.

-

Definition at line 22 of file JobResponse.cs.

-
22{ get; set; }
+

Definition at line 23 of file JobResponse.cs.

+
23{ get; set; }
@@ -211,9 +211,10 @@ Properties

The EntityId.Id of the Instance.

+

1

-

Definition at line 11 of file JobResponse.cs.

-
11{ get; set; }
+

Definition at line 12 of file JobResponse.cs.

+
12{ get; set; }
@@ -238,9 +239,10 @@ Properties

Optional progress between 0 and 100 inclusive.

+

25

-

Definition at line 28 of file JobResponse.cs.

-
28{ get; set; }
+

Definition at line 30 of file JobResponse.cs.

+
30{ get; set; }
@@ -264,10 +266,11 @@ Properties
-

Optional description of the job's current .

+

Optional description of the job's current progress.

+

Doing something important

-

Definition at line 34 of file JobResponse.cs.

-
34{ get; set; }
+

Definition at line 37 of file JobResponse.cs.

+
37{ get; set; }
@@ -293,8 +296,8 @@ Properties

The UserResponse that started the job.

-

Definition at line 16 of file JobResponse.cs.

-
16{ get; set; }
+

Definition at line 17 of file JobResponse.cs.

+
17{ get; set; }
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_log_file_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_log_file_response.html index 4c090ed1b6..f756d13d6f 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_log_file_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_log_file_response.html @@ -144,8 +144,8 @@ Properties

The DateTimeOffset of when the log file was modified.

-

Definition at line 18 of file LogFileResponse.cs.

-
18{ get; set; }
+

Definition at line 19 of file LogFileResponse.cs.

+
19{ get; set; }
@@ -170,9 +170,10 @@ Properties

The name of the log file.

+

tgs-20250118.log

-

Definition at line 13 of file LogFileResponse.cs.

-
13{ get; set; }
+

Definition at line 14 of file LogFileResponse.cs.

+
14{ get; set; }

Referenced by Tgstation.Server.Client.AdministrationClient.GetLog().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_paginated_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_paginated_response.html index ee79281e09..8d034aa47e 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_paginated_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_paginated_response.html @@ -158,9 +158,10 @@ Properties

The current size of pages in the query.

+

20

-

Definition at line 26 of file PaginatedResponse.cs.

-
26{ get; set; }
+

Definition at line 28 of file PaginatedResponse.cs.

+
28{ get; set; }

Referenced by Tgstation.Server.Client.PaginatedClient.ReadPaged< TModel >().

@@ -187,9 +188,10 @@ Properties

The total items across all pages.

+

100

-

Definition at line 31 of file PaginatedResponse.cs.

-
31{ get; set; }
+

Definition at line 34 of file PaginatedResponse.cs.

+
34{ get; set; }
@@ -214,9 +216,10 @@ Properties

The total number of pages in the query.

+

5

-

Definition at line 21 of file PaginatedResponse.cs.

-
21{ get; set; }
+

Definition at line 22 of file PaginatedResponse.cs.

+
22{ get; set; }
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html index 4a98b02d76..cdc43752d0 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_information_response.html @@ -170,9 +170,10 @@ Properties

The Api version of the host.

+

10.12.0

-

Definition at line 19 of file ServerInformationResponse.cs.

-
19{ get; set; }
+

Definition at line 21 of file ServerInformationResponse.cs.

+
21{ get; set; }
@@ -197,9 +198,10 @@ Properties

The DMAPI interop version the server uses.

+

7.3.0

-

Definition at line 24 of file ServerInformationResponse.cs.

-
24{ get; set; }
+

Definition at line 27 of file ServerInformationResponse.cs.

+
27{ get; set; }
@@ -225,8 +227,8 @@ Properties

Map of OAuthProvider to the OAuthProviderInfo for them.

-

Definition at line 34 of file ServerInformationResponse.cs.

-
34{ get; set; }
+

Definition at line 37 of file ServerInformationResponse.cs.

+
37{ get; set; }
@@ -252,8 +254,8 @@ Properties

A ICollection<T> of connected SwarmServerResponses.

-

Definition at line 45 of file ServerInformationResponse.cs.

-
45{ get; set; }
+

Definition at line 49 of file ServerInformationResponse.cs.

+
49{ get; set; }
@@ -278,9 +280,10 @@ Properties

If there is a server update in progress.

+

false

-

Definition at line 39 of file ServerInformationResponse.cs.

-
39{ get; set; }
+

Definition at line 43 of file ServerInformationResponse.cs.

+
43{ get; set; }
@@ -305,9 +308,10 @@ Properties

The version of the host.

+

6.12.3

-

Definition at line 14 of file ServerInformationResponse.cs.

-
14{ get; set; }
+

Definition at line 15 of file ServerInformationResponse.cs.

+
15{ get; set; }
@@ -333,8 +337,8 @@ Properties

If the server is running on a windows operating system.

-

Definition at line 29 of file ServerInformationResponse.cs.

-
29{ get; set; }
+

Definition at line 32 of file ServerInformationResponse.cs.

+
32{ get; set; }
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_update_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_update_response.html index dca525a7e4..107385382c 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_update_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_server_update_response.html @@ -161,15 +161,15 @@ Properties -

Definition at line 23 of file ServerUpdateResponse.cs.

-
24 {
-
25 NewVersion = newVersion ?? throw new ArgumentNullException(nameof(newVersion));
-
26 FileTicket = fileTicket;
-
27 }
+

Definition at line 24 of file ServerUpdateResponse.cs.

+
25 {
+
26 NewVersion = newVersion ?? throw new ArgumentNullException(nameof(newVersion));
+
27 FileTicket = fileTicket;
+
28 }
virtual ? string FileTicket
The ticket to use to access the Routes.Transfer controller.
-
Version NewVersion
The version of tgstation-server pending update.
+
Version NewVersion
The version of tgstation-server pending update.
-

References Tgstation.Server.Api.Models.Response.FileTicketResponse.FileTicket, and Tgstation.Server.Api.Models.Response.ServerUpdateResponse.NewVersion.

+

References Tgstation.Server.Api.Models.Response.FileTicketResponse.FileTicket, and Tgstation.Server.Api.Models.Response.ServerUpdateResponse.NewVersion.

@@ -195,11 +195,12 @@ Properties

The version of tgstation-server pending update.

+

6.12.3

-

Definition at line 15 of file ServerUpdateResponse.cs.

-
15{ get; }
+

Definition at line 16 of file ServerUpdateResponse.cs.

+
16{ get; }
-

Referenced by Tgstation.Server.Api.Models.Response.ServerUpdateResponse.ServerUpdateResponse().

+

Referenced by Tgstation.Server.Api.Models.Response.ServerUpdateResponse.ServerUpdateResponse().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html index 852644bb10..6654ecab71 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_token_response.html @@ -160,9 +160,10 @@ Here is the caller graph for this function:

The value of the JWT.

+

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxIiwibmJmIjoxNzM3MDkzNDgwLCJleHAiOjE3MzcwOTQzODAsImlhdCI6MTczNzA5MzQ4MCwiaXNzIjoiVGdzdGF0aW9uLlNlcnZlci5Ib3N0IiwiYXVkIjoiVGdzdGF0aW9uLlNlcnZlci5BcGkifQ.v64KX34_YOpH-HCbwqlx1p8u-MNbb4L6a9qEyXhcNcU

-

Definition at line 13 of file TokenResponse.cs.

-
13{ get; set; }
+

Definition at line 14 of file TokenResponse.cs.

+
14{ get; set; }

Referenced by Tgstation.Server.Api.ApiHeaders.ApiHeaders(), and Tgstation.Server.Client.RestServerClientFactory.CreateFromToken().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute.html index 2ff3af4473..673923ac76 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute.html @@ -140,7 +140,7 @@ Properties

Definition at line 14 of file ResponseOptionsAttribute.cs.

14{ get; set; }
-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.ApplyAttributesForRootSchema().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.ApplyAttributesForRootSchema().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html index 402a7e4ba3..266c51f7c7 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html @@ -140,11 +140,12 @@ Properties

Optional comment about the test.

+

this will fix everything -Admin

-

Definition at line 27 of file TestMergeParameters.cs.

-
27{ get; set; }
+

Definition at line 30 of file TestMergeParameters.cs.

+
30{ get; set; }
-

Referenced by Tgstation.Server.Host.Components.Repository.Repository.AddTestMerge(), Tgstation.Server.Host.Components.Repository.GitHubRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Host.Components.Repository.GitLabRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TestMergeModelBase(), and Tgstation.Server.Host.Models.TestMerge.ToApi().

+

Referenced by Tgstation.Server.Host.Components.Repository.Repository.AddTestMerge(), Tgstation.Server.Host.Components.Repository.GitHubRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Host.Components.Repository.GitLabRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TestMergeModelBase(), and Tgstation.Server.Host.Models.TestMerge.ToApi().

@@ -169,11 +170,12 @@ Properties

The number of the test merge source.

+

31026

-

Definition at line 13 of file TestMergeParameters.cs.

-
13{ get; set; }
+

Definition at line 14 of file TestMergeParameters.cs.

+
14{ get; set; }
-

Referenced by Tgstation.Server.Host.Components.Repository.Repository.AddTestMerge(), Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.GetTestMerge(), Tgstation.Server.Host.Components.Repository.GitHubRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Host.Components.Repository.GitLabRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TestMergeModelBase(), and Tgstation.Server.Host.Models.TestMerge.ToApi().

+

Referenced by Tgstation.Server.Host.Components.Repository.Repository.AddTestMerge(), Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.GetTestMerge(), Tgstation.Server.Host.Components.Repository.GitHubRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Host.Components.Repository.GitLabRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TestMergeModelBase(), and Tgstation.Server.Host.Models.TestMerge.ToApi().

@@ -198,11 +200,12 @@ Properties

The sha of the test merge revision to merge. If not specified, the latest commit from the source will be used.

+

caa1e1f400c8b6a535e03cff28cf57f919e9378c

-

Definition at line 20 of file TestMergeParameters.cs.

-
20{ get; set; }
+

Definition at line 22 of file TestMergeParameters.cs.

+
22{ get; set; }
-

Referenced by Tgstation.Server.Host.Components.Repository.Repository.AddTestMerge(), Tgstation.Server.Host.Utils.SwaggerConfiguration.ApplyAttributesForRootSchema(), Tgstation.Server.Host.Components.Repository.GitHubRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Host.Components.Repository.GitLabRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TestMergeModelBase(), and Tgstation.Server.Host.Models.TestMerge.ToApi().

+

Referenced by Tgstation.Server.Host.Components.Repository.Repository.AddTestMerge(), Tgstation.Server.Host.Utils.SwaggerConfiguration.ApplyAttributesForRootSchema(), Tgstation.Server.Host.Components.Repository.GitHubRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Host.Components.Repository.GitLabRemoteFeatures.GetTestMergeImpl(), Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TestMergeModelBase(), and Tgstation.Server.Host.Models.TestMerge.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_user_name.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_user_name.html index c3312a2378..bbde3e2ddb 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_user_name.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_user_name.html @@ -240,16 +240,16 @@ Here is the caller graph for this function: -

Definition at line 27 of file UserName.cs.

-
28 : UserName, new() => new()
-
29 {
-
30 Id = Id,
-
31 Name = Name,
-
32 };
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
override? string Name
Definition UserName.cs:11
+

Definition at line 28 of file UserName.cs.

+
29 : UserName, new() => new()
+
30 {
+
31 Id = Id,
+
32 Name = Name,
+
33 };
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
-

References Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Models.UserName.Name.

+

References Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Models.UserName.Name.

@@ -273,16 +273,15 @@ Here is the caller graph for this function:
+

Admin

-

- -

Definition at line 10 of file UserName.cs.

-
11 {
-
12 get => base.Name;
-
13 set => base.Name = value;
-
14 }
+

Definition at line 11 of file UserName.cs.

+
12 {
+
13 get => base.Name;
+
14 set => base.Name = value;
+
15 }
-

Referenced by Tgstation.Server.Host.Controllers.InstanceController.Create(), Tgstation.Server.Api.Models.UserName.CreateUserName< TResultType >(), and Tgstation.Server.Host.Jobs.JobService.RegisterOperation().

+

Referenced by Tgstation.Server.Host.Controllers.InstanceController.Create(), Tgstation.Server.Api.Models.UserName.CreateUserName< TResultType >(), and Tgstation.Server.Host.Jobs.JobService.RegisterOperation().

diff --git a/class_tgstation_1_1_server_1_1_client_1_1_administration_client.html b/class_tgstation_1_1_server_1_1_client_1_1_administration_client.html index 90e8028b1a..3a341a99c6 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_administration_client.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_administration_client.html @@ -284,7 +284,7 @@ Additional Inherited Members
Tgstation.Server.Client.PaginatedClient.ApiClient
IApiClient ApiClient
The IApiClient for the PaginatedClient.
Definition PaginatedClient.cs:21
Tgstation.Server.Client.ITransferClient.Download
ValueTask< Stream > Download(FileTicketResponse ticket, CancellationToken cancellationToken)
Downloads a file Stream for a given ticket .
-

References Tgstation.Server.Client.ApiClient.Download(), Tgstation.Server.Api.Models.Response.LogFileResponse.Name, and Tgstation.Server.Api.Routes.SanitizeGetPath().

+

References Tgstation.Server.Client.ApiClient.Download(), Tgstation.Server.Api.Models.Response.LogFileResponse.Name, and Tgstation.Server.Api.Routes.SanitizeGetPath().

Here is the call graph for this function:
@@ -473,12 +473,12 @@ Here is the call graph for this function:
49 return result;
50 }
Tgstation.Server.Api.Models.Request.ServerUpdateRequest
Represents a request to update TGS.
Definition ServerUpdateRequest.cs:9
-
Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip
bool? UploadZip
If the user will provide the server update package .zip file via file transfer as opposed to TGS retr...
Definition ServerUpdateRequest.cs:19
+
Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip
bool? UploadZip
If the user will provide the server update package .zip file via file transfer as opposed to TGS retr...
Definition ServerUpdateRequest.cs:20
Tgstation.Server.Api.Models.Response.ServerUpdateResponse
A response to a Request.ServerUpdateRequest.
Definition ServerUpdateResponse.cs:11
Tgstation.Server.Api.Routes.Administration
const string Administration
The server administration controller.
Definition Routes.cs:28
Tgstation.Server.Client.ITransferClient.Upload
ValueTask Upload(FileTicketResponse ticket, Stream? uploadStream, CancellationToken cancellationToken)
Uploads a given uploadStream for a given ticket .
-

References Tgstation.Server.Api.Routes.Administration, Tgstation.Server.Client.ApiClient.Upload(), and Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip.

+

References Tgstation.Server.Api.Routes.Administration, Tgstation.Server.Client.ApiClient.Upload(), and Tgstation.Server.Api.Models.Request.ServerUpdateRequest.UploadZip.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_client_1_1_api_exception.html b/class_tgstation_1_1_server_1_1_client_1_1_api_exception.html index b81fa4d296..cb9e751e95 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_api_exception.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_api_exception.html @@ -233,7 +233,7 @@ Properties
Version? ServerApiVersion
The Version of the server's API.
ErrorCode
Types of Response.ErrorMessageResponses that the API may return.
Definition ErrorCode.cs:12
-

References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.AdditionalData, Tgstation.Server.Client.ApiException.AdditionalServerData, Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorCode, Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ServerApiVersion, and Tgstation.Server.Client.ApiException.ServerApiVersion.

+

References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.AdditionalData, Tgstation.Server.Client.ApiException.AdditionalServerData, Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ErrorCode, Tgstation.Server.Api.Models.Response.ErrorMessageResponse.ServerApiVersion, and Tgstation.Server.Client.ApiException.ServerApiVersion.

diff --git a/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_configuration_client.html b/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_configuration_client.html index c386280640..0a63753e83 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_configuration_client.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_configuration_client.html @@ -516,14 +516,14 @@ Here is the caller graph for this function:
68 throw;
69 }
70 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Response.ConfigurationFileResponse
Response when reading configuration files.
Definition ConfigurationFileResponse.cs:7
Tgstation.Server.Api.Routes
Routes to a server actions.
Definition Routes.cs:9
Tgstation.Server.Api.Routes.SanitizeGetPath
static string SanitizeGetPath(string path)
Sanitize a Models.Response.FileTicketResponse path for use in a GET Uri.
Definition Routes.cs:140
Tgstation.Server.Client.PaginatedClient.ApiClient
IApiClient ApiClient
The IApiClient for the PaginatedClient.
Definition PaginatedClient.cs:21
Tgstation.Server.Client.ITransferClient.Download
ValueTask< Stream > Download(FileTicketResponse ticket, CancellationToken cancellationToken)
Downloads a file Stream for a given ticket .
-

References Tgstation.Server.Client.ApiClient.Download(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Client.Components.ConfigurationClient.instance, Tgstation.Server.Client.Components.ConfigurationClient.List(), and Tgstation.Server.Api.Routes.SanitizeGetPath().

+

References Tgstation.Server.Client.ApiClient.Download(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Client.Components.ConfigurationClient.instance, Tgstation.Server.Client.Components.ConfigurationClient.List(), and Tgstation.Server.Api.Routes.SanitizeGetPath().

Here is the call graph for this function:
@@ -619,7 +619,7 @@ Here is the call graph for this function:
Tgstation.Server.Api.Routes.Configuration
const string Configuration
The configuration controller.
Definition Routes.cs:73
Tgstation.Server.Client.ITransferClient.Upload
ValueTask Upload(FileTicketResponse ticket, Stream? uploadStream, CancellationToken cancellationToken)
Uploads a given uploadStream for a given ticket .
-

References Tgstation.Server.Api.Routes.Configuration, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Client.Components.ConfigurationClient.instance, Tgstation.Server.Client.Components.ConfigurationClient.List(), and Tgstation.Server.Client.ApiClient.Upload().

+

References Tgstation.Server.Api.Routes.Configuration, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Client.Components.ConfigurationClient.instance, Tgstation.Server.Client.Components.ConfigurationClient.List(), and Tgstation.Server.Client.ApiClient.Upload().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html b/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html index c35a5fa21f..dbfa60f977 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_engine_client.html @@ -464,7 +464,7 @@ Additional Inherited Members
61
62 return result;
63 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
A request to switch to a given EngineVersion.
bool? UploadCustomZip
If a custom BYOND version is to be uploaded.
Represents an engine installation job. FileTicketResponse.FileTicket is used to upload custom version...
@@ -473,7 +473,7 @@ Additional Inherited Members
IApiClient ApiClient
The IApiClient for the PaginatedClient.
ValueTask Upload(FileTicketResponse ticket, Stream? uploadStream, CancellationToken cancellationToken)
Uploads a given uploadStream for a given ticket .
-

References Tgstation.Server.Api.Routes.Engine, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Client.Components.EngineClient.instance, Tgstation.Server.Client.ApiClient.Upload(), and Tgstation.Server.Api.Models.Request.EngineVersionRequest.UploadCustomZip.

+

References Tgstation.Server.Api.Routes.Engine, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Client.Components.EngineClient.instance, Tgstation.Server.Client.ApiClient.Upload(), and Tgstation.Server.Api.Models.Request.EngineVersionRequest.UploadCustomZip.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_instance_client.html b/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_instance_client.html index 21554f0385..dbe74acaf7 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_instance_client.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_components_1_1_instance_client.html @@ -199,7 +199,7 @@ Properties
57 DreamMaker = new DreamMakerClient(apiClient, instance);
58 Jobs = new JobsClient(apiClient, instance);
59 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Instance Metadata
The Instance used to create the IInstanceClient.
IEngineClient Engine
Access the IEngineClient.
IDreamDaemonClient DreamDaemon
Access the IDreamDaemonClient.
@@ -210,7 +210,7 @@ Properties
IChatBotsClient ChatBots
Access the IChatBotsClient.
IDreamMakerClient DreamMaker
Access the IDreamMakerClient.
-

References Tgstation.Server.Client.Components.InstanceClient.ChatBots, Tgstation.Server.Client.Components.InstanceClient.Configuration, Tgstation.Server.Client.Components.InstanceClient.DreamDaemon, Tgstation.Server.Client.Components.InstanceClient.DreamMaker, Tgstation.Server.Client.Components.InstanceClient.Engine, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Client.Components.InstanceClient.Jobs, Tgstation.Server.Client.Components.InstanceClient.Metadata, Tgstation.Server.Client.Components.InstanceClient.PermissionSets, and Tgstation.Server.Client.Components.InstanceClient.Repository.

+

References Tgstation.Server.Client.Components.InstanceClient.ChatBots, Tgstation.Server.Client.Components.InstanceClient.Configuration, Tgstation.Server.Client.Components.InstanceClient.DreamDaemon, Tgstation.Server.Client.Components.InstanceClient.DreamMaker, Tgstation.Server.Client.Components.InstanceClient.Engine, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Client.Components.InstanceClient.Jobs, Tgstation.Server.Client.Components.InstanceClient.Metadata, Tgstation.Server.Client.Components.InstanceClient.PermissionSets, and Tgstation.Server.Client.Components.InstanceClient.Repository.

diff --git a/class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html b/class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html index aa1ba954cd..575d334d45 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_instance_manager_client.html @@ -289,11 +289,11 @@ Additional Inherited Members
55 ApiClient,
56 instance);
57 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Client.Components.InstanceClient
Definition InstanceClient.cs:9
Tgstation.Server.Client.PaginatedClient.ApiClient
IApiClient ApiClient
The IApiClient for the PaginatedClient.
Definition PaginatedClient.cs:21
-

References Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Client.InstanceManagerClient.List().

+

References Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Client.InstanceManagerClient.List().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_client_1_1_paginated_client.html b/class_tgstation_1_1_server_1_1_client_1_1_paginated_client.html index c6e7baeb3a..62ff3bcf64 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_paginated_client.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_paginated_client.html @@ -314,10 +314,10 @@ Properties
122 return results;
123 }
Represents a paginated set of models.
-
int PageSize
The current size of pages in the query.
+
int PageSize
The current size of pages in the query.
@ Read
User can read all chat bot properties except Models.Internal.ChatBotSettings.ConnectionString.
-

References Tgstation.Server.Client.PaginationSettings.Offset, Tgstation.Server.Api.Models.Response.PaginatedResponse< TModel >.PageSize, Tgstation.Server.Client.PaginationSettings.PageSize, and Tgstation.Server.Client.PaginationSettings.RetrieveCount.

+

References Tgstation.Server.Client.PaginationSettings.Offset, Tgstation.Server.Api.Models.Response.PaginatedResponse< TModel >.PageSize, Tgstation.Server.Client.PaginationSettings.PageSize, and Tgstation.Server.Client.PaginationSettings.RetrieveCount.

diff --git a/class_tgstation_1_1_server_1_1_client_1_1_rest_server_client_factory.html b/class_tgstation_1_1_server_1_1_client_1_1_rest_server_client_factory.html index 8a3aeaa88d..45c9044e37 100644 --- a/class_tgstation_1_1_server_1_1_client_1_1_rest_server_client_factory.html +++ b/class_tgstation_1_1_server_1_1_client_1_1_rest_server_client_factory.html @@ -525,10 +525,10 @@ Here is the call graph for this function:
112 false));
113 return serverClient;
114 }
-
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:13
+
Tgstation.Server.Api.Models.Response.TokenResponse.Bearer
string? Bearer
The value of the JWT.
Definition TokenResponse.cs:14
Tgstation.Server.Client.IApiClientFactory.CreateApiClient
IApiClient CreateApiClient(Uri url, ApiHeaders apiHeaders, ApiHeaders? tokenRefreshHeaders, bool authless)
Create an IApiClient.
-

References Tgstation.Server.Api.Models.Response.TokenResponse.Bearer, Tgstation.Server.Client.ApiClientFactory.CreateApiClient(), and Tgstation.Server.Client.RestServerClientFactory.productHeaderValue.

+

References Tgstation.Server.Api.Models.Response.TokenResponse.Bearer, Tgstation.Server.Client.ApiClientFactory.CreateApiClient(), and Tgstation.Server.Client.RestServerClientFactory.productHeaderValue.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_login_authority.html b/class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_login_authority.html index c31b8f1a74..5acd20e80e 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_login_authority.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_login_authority.html @@ -519,7 +519,7 @@ Additional Inherited Members
264 }
265 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
ILogger< AuthorityBase > Logger
Gets the ILogger for the AuthorityBase.
Represents a response from an authority.
async ValueTask CacheSystemIdentity(ISystemIdentity systemIdentity, User user, LoginResult loginPayload)
Add a given systemIdentity to the identityCache.
@@ -546,7 +546,7 @@ Additional Inherited Members
ErrorCode
Types of Response.ErrorMessageResponses that the API may return.
Definition ErrorCode.cs:12
@ Id
Lookup the Api.Models.EntityId.Id of the Models.PermissionSet.
-

References Tgstation.Server.Host.Utils.IApiHeadersProvider.ApiHeaders, Tgstation.Server.Host.Authority.LoginAuthority.apiHeadersProvider, Tgstation.Server.Host.Authority.LoginAuthority.CacheSystemIdentity(), Tgstation.Server.Host.Models.User.CanonicalizeName(), Tgstation.Server.Host.Security.ICryptographySuite.CheckUserPassword(), Tgstation.Server.Host.Security.ISystemIdentityFactory.CreateSystemIdentity(), Tgstation.Server.Host.Security.ITokenFactory.CreateToken(), Tgstation.Server.Host.Authority.LoginAuthority.cryptographySuite, Tgstation.Server.Host.Utils.IApiHeadersProvider.HeadersException, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Authority.Id, Tgstation.Server.Host.Authority.Core.AuthorityBase.Logger, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Authority.LoginAuthority.SelectUserInfoFromQuery(), Tgstation.Server.Host.Authority.LoginAuthority.sessionInvalidationTracker, Tgstation.Server.Host.Authority.LoginAuthority.systemIdentityFactory, Tgstation.Server.Host.Models.User.TgsSystemUserName, Tgstation.Server.Host.Models.User.ToApi(), Tgstation.Server.Host.Authority.LoginAuthority.tokenFactory, Tgstation.Server.Host.Security.ISystemIdentity.Uid, Tgstation.Server.Host.Security.ISessionInvalidationTracker.UserModifiedInvalidateSessions(), Tgstation.Server.Host.Security.ISystemIdentity.Username, and Tgstation.Server.Host.Database.DatabaseContext.Users.

+

References Tgstation.Server.Host.Utils.IApiHeadersProvider.ApiHeaders, Tgstation.Server.Host.Authority.LoginAuthority.apiHeadersProvider, Tgstation.Server.Host.Authority.LoginAuthority.CacheSystemIdentity(), Tgstation.Server.Host.Models.User.CanonicalizeName(), Tgstation.Server.Host.Security.ICryptographySuite.CheckUserPassword(), Tgstation.Server.Host.Security.ISystemIdentityFactory.CreateSystemIdentity(), Tgstation.Server.Host.Security.ITokenFactory.CreateToken(), Tgstation.Server.Host.Authority.LoginAuthority.cryptographySuite, Tgstation.Server.Host.Utils.IApiHeadersProvider.HeadersException, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Authority.Id, Tgstation.Server.Host.Authority.Core.AuthorityBase.Logger, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Authority.LoginAuthority.SelectUserInfoFromQuery(), Tgstation.Server.Host.Authority.LoginAuthority.sessionInvalidationTracker, Tgstation.Server.Host.Authority.LoginAuthority.systemIdentityFactory, Tgstation.Server.Host.Models.User.TgsSystemUserName, Tgstation.Server.Host.Models.User.ToApi(), Tgstation.Server.Host.Authority.LoginAuthority.tokenFactory, Tgstation.Server.Host.Security.ISystemIdentity.Uid, Tgstation.Server.Host.Security.ISessionInvalidationTracker.UserModifiedInvalidateSessions(), Tgstation.Server.Host.Security.ISystemIdentity.Username, and Tgstation.Server.Host.Database.DatabaseContext.Users.

Here is the call graph for this function:
@@ -771,7 +771,7 @@ Here is the caller graph for this function:
Returns
A new, errored LoginResult AuthorityResponse<TResult>.
-

References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.Message.

+

References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.Message.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_user_authority.html b/class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_user_authority.html index afdedbac05..38d29d7e2d 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_user_authority.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_user_authority.html @@ -999,14 +999,14 @@ Here is the caller graph for this function:
279
280 return new AuthorityResponse<User>(user);
281 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Host.Authority.UserAuthority.Queryable
IQueryable< User > Queryable(bool includeJoins)
Gets all registered Users.A IQueryable<T> of Users.
Tgstation.Server.Host.Models.User.TgsSystemUserName
const string TgsSystemUserName
Username used when creating jobs automatically.
Definition User.cs:21
Tgstation.Server.Host.Models.User.CanonicalName
string? CanonicalName
The uppercase invariant of UserName.Name.
Definition User.cs:58
Tgstation.Server.Host.Security.AuthenticationContext.GetRight
ulong GetRight(RightsType rightsType)
Get the value of a given rightsType .The value of rightsType . Note that if InstancePermissionSet is ...
Definition AuthenticationContext.cs:103
Tgstation.Server.Api.Rights.RightsType
RightsType
The type of rights a model uses.
Definition RightsType.cs:7
-

References Tgstation.Server.Host.Models.User.CanonicalizeName(), Tgstation.Server.Host.Models.User.CanonicalName, Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Authority.UserAuthority.Queryable(), Tgstation.Server.Host.Models.User.TgsSystemUserName, Tgstation.Server.Host.Security.AuthenticationContext.User, and Tgstation.Server.Host.Authority.UserAuthority.usersDataLoader.

+

References Tgstation.Server.Host.Models.User.CanonicalizeName(), Tgstation.Server.Host.Models.User.CanonicalName, Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Authority.UserAuthority.Queryable(), Tgstation.Server.Host.Models.User.TgsSystemUserName, Tgstation.Server.Host.Security.AuthenticationContext.User, and Tgstation.Server.Host.Authority.UserAuthority.usersDataLoader.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_commands_1_1_engine_command.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_commands_1_1_engine_command.html index 61b2432bcc..80f6ab8818 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_commands_1_1_engine_command.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_commands_1_1_engine_command.html @@ -308,16 +308,16 @@ Private Attributes
93 });
94 }
Information about an engine installation.
-
static EngineVersion Parse(string input)
Parses a stringified EngineVersion.
+
static EngineVersion Parse(string input)
Parses a stringified EngineVersion.
EngineType? Engine
The EngineType.
-
int? CustomIteration
The revision of the custom build.
+
int? CustomIteration
The revision of the custom build.
Represents a message to send to a chat provider.
EngineVersion? ActiveVersion
The currently active EngineVersion.
Models.? CompileJob ActiveCompileJob
Retrieves the Models.CompileJob currently running on the server.
Definition IWatchdog.cs:50
WatchdogStatus Status
The current WatchdogStatus.
Definition IWatchdog.cs:35
WatchdogStatus
The current status of the watchdog.
-

References Tgstation.Server.Host.Components.Watchdog.IWatchdog.ActiveCompileJob, Tgstation.Server.Host.Components.Engine.IEngineManager.ActiveVersion, Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.engineManager, Tgstation.Server.Api.Models.EngineVersion.Parse(), Tgstation.Server.Host.Components.Watchdog.IWatchdog.Status, and Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.watchdog.

+

References Tgstation.Server.Host.Components.Watchdog.IWatchdog.ActiveCompileJob, Tgstation.Server.Host.Components.Engine.IEngineManager.ActiveVersion, Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.engineManager, Tgstation.Server.Api.Models.EngineVersion.Parse(), Tgstation.Server.Host.Components.Watchdog.IWatchdog.Status, and Tgstation.Server.Host.Components.Chat.Commands.EngineCommand.watchdog.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_providers_1_1_irc_provider.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_providers_1_1_irc_provider.html index 9488bdf4d1..499b831d57 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_providers_1_1_irc_provider.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_chat_1_1_providers_1_1_irc_provider.html @@ -1681,14 +1681,14 @@ Here is the caller graph for this function:
291 return active => ValueTask.CompletedTask;
292 };
293 }
-
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:177
+
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:179
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
Tgstation.Server.Api.Models.TestMerge
Definition TestMerge.cs:7
Tgstation.Server.Host.Components.Chat.Providers.IrcProvider.SendMessage
override async ValueTask SendMessage(Message? replyTo, MessageContent message, ulong channelId, CancellationToken cancellationToken)
Send a message to the IProvider.A ValueTask representing the running operation.
Definition IrcProvider.cs:164
Tgstation.Server.Host.Components.Chat.Providers.Provider.GetEngineCompilerPrefix
static string GetEngineCompilerPrefix(Api.Models.EngineType engineType)
Get the prefix for messages about deployments.
Tgstation.Server.Host.Components.Interop.MessageContent
Represents a message to send to a chat provider.
Definition MessageContent.cs:7
-

References Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Host.Components.Chat.Providers.Provider.GetEngineCompilerPrefix(), Tgstation.Server.Host.Components.Chat.Providers.IrcProvider.SendMessage(), and Tgstation.Server.Api.Models.EngineVersion.ToString().

+

References Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Host.Components.Chat.Providers.Provider.GetEngineCompilerPrefix(), Tgstation.Server.Host.Components.Chat.Providers.IrcProvider.SendMessage(), and Tgstation.Server.Api.Models.EngineVersion.ToString().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_deployment_lock_manager.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_deployment_lock_manager.html index 4f7e81d6a0..1ec6366b86 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_deployment_lock_manager.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_deployment_lock_manager.html @@ -256,7 +256,7 @@ Private Attributes
83 locks = new HashSet<DmbLock>();
84 firstLock = CreateLock(initialLockReason, callerFile, callerLine);
85 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
readonly DmbLock firstLock
The first lock acquired by the DeploymentLockManager.
readonly ILogger logger
The ILogger for the DeploymentLockManager.
readonly HashSet< DmbLock > locks
The DmbLocks on the dmbProvider.
@@ -264,7 +264,7 @@ Private Attributes
DmbLock CreateLock(string reason, string callerFile, int callerLine)
Creates a DmbLock and adds it to locks.
Models.CompileJob CompileJob
The CompileJob of the .dmb.
-

References Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.CreateLock(), Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.dmbProvider, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.firstLock, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.locks, and Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.logger.

+

References Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.CreateLock(), Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.dmbProvider, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.firstLock, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.locks, and Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.logger.

Here is the call graph for this function:
@@ -577,7 +577,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.GetFullLockDescriptor
static string GetFullLockDescriptor(DmbLock dmbLock)
Generates a verbose description of a given dmbLock .
Tgstation.Server.Host.Models.CompileJob
Definition CompileJob.cs:11
-

References Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.dmbProvider, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.firstLock, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.GetFullLockDescriptor(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.locks, and Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.logger.

+

References Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.dmbProvider, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.firstLock, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.GetFullLockDescriptor(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.locks, and Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.logger.

Referenced by Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.AddLock(), and Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.DeploymentLockManager().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_dmb_factory.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_dmb_factory.html index d7253c70bc..bbb223215b 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_dmb_factory.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_dmb_factory.html @@ -484,14 +484,14 @@ Private Attributes
501 cleanupTask = HandleCleanup();
502 }
-
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:28
+
Guid? DirectoryName
The Game folder the results were compiled into.
Definition CompileJob.cs:29
Extension methods for the ValueTask and ValueTask<TResult> classes.
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
async ValueTask DeleteCompileJobContent(string directory, CancellationToken cancellationToken)
Handles cleaning the resources of a CompileJob.
IRemoteDeploymentManager CreateRemoteDeploymentManager(Api.Models.Instance metadata, RemoteGitProvider remoteGitProvider)
Creates a IRemoteDeploymentManager for a given remoteGitProvider .
ValueTask MarkInactive(CompileJob compileJob, CancellationToken cancellationToken)
Mark the deplotment for a given compileJob as inactive.
-

References Tgstation.Server.Host.Components.Deployment.DmbFactory.cleanupCts, Tgstation.Server.Host.Components.Deployment.DmbFactory.cleanupTask, Tgstation.Server.Host.Components.Deployment.Remote.IRemoteDeploymentManagerFactory.CreateRemoteDeploymentManager(), Tgstation.Server.Host.Components.Deployment.DmbFactory.DeleteCompileJobContent(), Tgstation.Server.Api.Models.Internal.CompileJob.DirectoryName, Tgstation.Server.Host.Components.Deployment.DmbFactory.jobLockManagers, Tgstation.Server.Host.Components.Deployment.DmbFactory.logger, Tgstation.Server.Host.Components.Deployment.Remote.IRemoteDeploymentManager.MarkInactive(), Tgstation.Server.Host.Components.Deployment.DmbFactory.metadata, Tgstation.Server.Host.Components.Deployment.DmbFactory.remoteDeploymentManagerFactory, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

+

References Tgstation.Server.Host.Components.Deployment.DmbFactory.cleanupCts, Tgstation.Server.Host.Components.Deployment.DmbFactory.cleanupTask, Tgstation.Server.Host.Components.Deployment.Remote.IRemoteDeploymentManagerFactory.CreateRemoteDeploymentManager(), Tgstation.Server.Host.Components.Deployment.DmbFactory.DeleteCompileJobContent(), Tgstation.Server.Api.Models.Internal.CompileJob.DirectoryName, Tgstation.Server.Host.Components.Deployment.DmbFactory.jobLockManagers, Tgstation.Server.Host.Components.Deployment.DmbFactory.logger, Tgstation.Server.Host.Components.Deployment.Remote.IRemoteDeploymentManager.MarkInactive(), Tgstation.Server.Host.Components.Deployment.DmbFactory.metadata, Tgstation.Server.Host.Components.Deployment.DmbFactory.remoteDeploymentManagerFactory, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

Referenced by Tgstation.Server.Host.Components.Deployment.DmbFactory.FromCompileJobInternal().

@@ -1083,9 +1083,9 @@ Here is the caller graph for this function:
461 }
462 }
Tgstation.Server.Api.Models.EngineVersion
Information about an engine installation.
Definition EngineVersion.cs:14
-
Tgstation.Server.Api.Models.EngineVersion.TryParse
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
Definition EngineVersion.cs:51
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
Tgstation.Server.Api.Models.Internal.Job.StoppedAt
DateTimeOffset? StoppedAt
When the Job stopped.
Definition Job.cs:48
+
Tgstation.Server.Api.Models.EngineVersion.TryParse
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
Definition EngineVersion.cs:53
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
Tgstation.Server.Api.Models.Internal.Job.StoppedAt
DateTimeOffset? StoppedAt
When the Job stopped.
Definition Job.cs:49
Tgstation.Server.Host.Components.Deployment.DmbFactory.CleanRegisteredCompileJob
void CleanRegisteredCompileJob(CompileJob job)
Delete the Api.Models.Internal.CompileJob.DirectoryName of job .
Definition DmbFactory.cs:468
Tgstation.Server.Host.Models.CompileJob.Job
Job Job
See CompileJobResponse.Job.
Definition CompileJob.cs:16
Tgstation.Server.Host.Models.CompileJob.EngineVersion
string EngineVersion
The Version the CompileJob was made with in string form.
Definition CompileJob.cs:33
@@ -1093,7 +1093,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.IO.IIOManager.ConcatPath
string ConcatPath(params string[] paths)
Combines an array of strings into a path.
Tgstation.Server.Host.IO.IIOManager.FileExists
Task< bool > FileExists(string path, CancellationToken cancellationToken)
Check that the file at path exists.
-

References Tgstation.Server.Host.Components.Deployment.DmbFactory.CleanRegisteredCompileJob(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.Create(), Tgstation.Server.Host.Components.Deployment.DmbFactory.databaseContextFactory, Tgstation.Server.Host.Models.CompileJob.EngineVersion, Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Deployment.DmbFactory.ioManager, Tgstation.Server.Host.Models.CompileJob.Job, Tgstation.Server.Host.Components.Deployment.DmbFactory.jobLockManagers, Tgstation.Server.Host.Components.Deployment.DmbFactory.logger, Tgstation.Server.Api.Models.Internal.Job.StoppedAt, Tgstation.Server.Api.Models.EngineVersion.TryParse(), and Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext().

+

References Tgstation.Server.Host.Components.Deployment.DmbFactory.CleanRegisteredCompileJob(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Deployment.DeploymentLockManager.Create(), Tgstation.Server.Host.Components.Deployment.DmbFactory.databaseContextFactory, Tgstation.Server.Host.Models.CompileJob.EngineVersion, Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Deployment.DmbFactory.ioManager, Tgstation.Server.Host.Models.CompileJob.Job, Tgstation.Server.Host.Components.Deployment.DmbFactory.jobLockManagers, Tgstation.Server.Host.Components.Deployment.DmbFactory.logger, Tgstation.Server.Api.Models.Internal.Job.StoppedAt, Tgstation.Server.Api.Models.EngineVersion.TryParse(), and Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext().

Referenced by Tgstation.Server.Host.Components.Deployment.DmbFactory.FromCompileJob(), and Tgstation.Server.Host.Components.Deployment.DmbFactory.LoadCompileJob().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_dream_maker.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_dream_maker.html index a5a962fb39..cd6ba7df2e 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_dream_maker.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_deployment_1_1_dream_maker.html @@ -1871,9 +1871,9 @@ Here is the caller graph for this function:
702 throw;
703 }
704 }
-
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:177
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput
bool? LogOutput
If process output/error text should be logged.
Definition DreamDaemonLaunchParameters.cs:99
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:62
+
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:179
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput
bool? LogOutput
If process output/error text should be logged.
Definition DreamDaemonLaunchParameters.cs:107
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:68
Tgstation.Server.Host.Components.Deployment.DreamMaker.VerifyApi
async ValueTask VerifyApi(uint timeout, DreamDaemonSecurity securityLevel, Models.CompileJob job, JobProgressReporter progressReporter, IEngineExecutableLock engineLock, ushort portToUse, DMApiValidationMode validationMode, bool logOutput, CancellationToken cancellationToken)
Run a quick DD instance to test the DMAPI is installed on the target code.
Definition DreamMaker.cs:777
Tgstation.Server.Host.Components.Deployment.DreamMaker.ModifyDme
async ValueTask ModifyDme(Models.CompileJob job, CancellationToken cancellationToken)
Adds server side includes to the .dme being compiled.
Definition DreamMaker.cs:913
Tgstation.Server.Host.Components.Deployment.DreamMaker.RunDreamMaker
async ValueTask< bool > RunDreamMaker(IEngineExecutableLock engineLock, Models.CompileJob job, string? additionalCompilerArguments, CancellationToken cancellationToken)
Compiles a .dme with DreamMaker.
Definition DreamMaker.cs:872
@@ -1884,7 +1884,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.IO.IIOManager.FileExists
Task< bool > FileExists(string path, CancellationToken cancellationToken)
Check that the file at path exists.
Tgstation.Server.Host.IO.IIOManager.GetFilesWithExtension
Task< List< string > > GetFilesWithExtension(string path, string extension, bool recursive, CancellationToken cancellationToken)
Gets a list of files in path with the given extension .
-

References Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Deployment.DreamMaker.configuration, Tgstation.Server.Host.Components.Repository.IRepository.CopyTo(), Tgstation.Server.Host.Components.Deployment.DreamMaker.DmeExtension, Tgstation.Server.Host.Components.Deployment.DreamMaker.eventConsumer, Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.IO.IIOManager.GetFilesWithExtension(), Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Host.Components.Deployment.DreamMaker.ioManager, Tgstation.Server.Host.Components.Deployment.DreamMaker.logger, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput, Tgstation.Server.Host.Components.Deployment.DreamMaker.ModifyDme(), Tgstation.Server.Host.Components.Repository.IRepository.Origin, Tgstation.Server.Host.IO.IIOManager.PathIsChildOf(), Tgstation.Server.Host.Components.Repository.IRepository.Reference, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Host.Components.Deployment.DreamMaker.RunDreamMaker(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout, Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Host.Components.Deployment.DreamMaker.VerifyApi(), and Tgstation.Server.Host.Components.Engine.IEngineInstallation.Version.

+

References Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Deployment.DreamMaker.configuration, Tgstation.Server.Host.Components.Repository.IRepository.CopyTo(), Tgstation.Server.Host.Components.Deployment.DreamMaker.DmeExtension, Tgstation.Server.Host.Components.Deployment.DreamMaker.eventConsumer, Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.IO.IIOManager.GetFilesWithExtension(), Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Host.Components.Deployment.DreamMaker.ioManager, Tgstation.Server.Host.Components.Deployment.DreamMaker.logger, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput, Tgstation.Server.Host.Components.Deployment.DreamMaker.ModifyDme(), Tgstation.Server.Host.Components.Repository.IRepository.Origin, Tgstation.Server.Host.IO.IIOManager.PathIsChildOf(), Tgstation.Server.Host.Components.Repository.IRepository.Reference, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Host.Components.Deployment.DreamMaker.RunDreamMaker(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout, Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Host.Components.Deployment.DreamMaker.VerifyApi(), and Tgstation.Server.Host.Components.Engine.IEngineInstallation.Version.

Referenced by Tgstation.Server.Host.Components.Deployment.DreamMaker.Compile().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_byond_installation.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_byond_installation.html index b9138383bd..e3a54ac0dc 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_byond_installation.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_byond_installation.html @@ -513,14 +513,14 @@ Additional Inherited Members
145 parametersString);
146 return arguments;
147 }
-
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
-
bool? AllowWebClient
If the BYOND web client can be used to connect to the game server. No-op for EngineType....
+
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
+
bool? AllowWebClient
If the BYOND web client can be used to connect to the game server. No-op for EngineType....
static string VisibilityWord(DreamDaemonVisibility visibility)
Change a given visibility into the appropriate DreamDaemon command line word.
static string SecurityWord(DreamDaemonSecurity securityLevel)
Change a given securityLevel into the appropriate DreamDaemon command line word.
static string EncodeParameters(IReadOnlyDictionary< string, string > parameters, DreamDaemonLaunchParameters launchParameters)
Encode given parameters for passing as world.params on the command line.
string DmbName
The file name of the .dmb.
-

References Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AllowWebClient, Tgstation.Server.Host.Components.Deployment.IDmbProvider.DmbName, Tgstation.Server.Host.Components.Engine.EngineInstallationBase.EncodeParameters(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.MapThreads, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel, Tgstation.Server.Host.Components.Engine.ByondInstallation.SecurityWord(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartProfiler, Tgstation.Server.Host.Components.Engine.ByondInstallation.supportsMapThreads, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility, and Tgstation.Server.Host.Components.Engine.ByondInstallation.VisibilityWord().

+

References Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AllowWebClient, Tgstation.Server.Host.Components.Deployment.IDmbProvider.DmbName, Tgstation.Server.Host.Components.Engine.EngineInstallationBase.EncodeParameters(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.MapThreads, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel, Tgstation.Server.Host.Components.Engine.ByondInstallation.SecurityWord(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartProfiler, Tgstation.Server.Host.Components.Engine.ByondInstallation.supportsMapThreads, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility, and Tgstation.Server.Host.Components.Engine.ByondInstallation.VisibilityWord().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_byond_installer_base.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_byond_installer_base.html index 8f42e57c23..22d614d993 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_byond_installer_base.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_byond_installer_base.html @@ -606,7 +606,7 @@ Here is the call graph for this function:
99 supportsCli,
100 supportsMapThreads));
101 }
-
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:30
+
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:31
Tgstation.Server.Host.Components.Engine.ByondInstallerBase.GetDreamDaemonName
string GetDreamDaemonName(Version byondVersion, out bool supportsCli)
Get the file name of the DreamDaemon executable.
Tgstation.Server.Host.Components.Engine.ByondInstallerBase.MapThreadsVersion
static readonly Version MapThreadsVersion
The first Version of BYOND that supports the '-map-threads' parameter on DreamDaemon.
Definition ByondInstallerBase.cs:39
Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath
const string ByondBinPath
The path to the BYOND bin folder.
Definition ByondInstallerBase.cs:24
@@ -614,7 +614,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity
void CheckVersionValidity(EngineVersion version)
Check that a given version is of type EngineType.Byond.
Definition EngineInstallerBase.cs:64
Tgstation.Server.Host.IO.ResolvingIOManager
An IIOManager that resolve relative paths from another IIOManager to a subdirectory of that.
Definition ResolvingIOManager.cs:10
-

References Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.DreamMakerName, Tgstation.Server.Host.Components.Engine.ByondInstallerBase.GetDreamDaemonName(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.IOManager, Tgstation.Server.Host.Components.Engine.ByondInstallerBase.MapThreadsVersion, and Tgstation.Server.Api.Models.EngineVersion.Version.

+

References Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.DreamMakerName, Tgstation.Server.Host.Components.Engine.ByondInstallerBase.GetDreamDaemonName(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.IOManager, Tgstation.Server.Host.Components.Engine.ByondInstallerBase.MapThreadsVersion, and Tgstation.Server.Api.Models.EngineVersion.Version.

Here is the call graph for this function:
@@ -764,7 +764,7 @@ Here is the call graph for this function:
200 }
Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondRevisionsUrlTemplate
string ByondRevisionsUrlTemplate
Gets the URL formatter string for downloading a byond version of {0:Major} {1:Minor}.
Definition ByondInstallerBase.cs:57
-

References Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondRevisionsUrlTemplate, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), and Tgstation.Server.Api.Models.EngineVersion.Version.

+

References Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondRevisionsUrlTemplate, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), and Tgstation.Server.Api.Models.EngineVersion.Version.

Referenced by Tgstation.Server.Host.Components.Engine.ByondInstallerBase.DownloadVersion().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_installation_base.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_installation_base.html index 6ab2831aba..fa938c2335 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_installation_base.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_installation_base.html @@ -295,9 +295,9 @@ Properties
67
68 return parametersString;
69 }
-
string? AdditionalParameters
Parameters string for DreamDaemon.
+
string? AdditionalParameters
Parameters string for DreamDaemon.
-

References Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AdditionalParameters.

+

References Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.AdditionalParameters.

Referenced by Tgstation.Server.Host.Components.Engine.ByondInstallation.FormatServerArguments(), and Tgstation.Server.Host.Components.Engine.OpenDreamInstallation.FormatServerArguments().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html index 47b4e02925..b8b20320e1 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html @@ -589,8 +589,8 @@ Here is the caller graph for this function:
529 }
530 }
Exception
-
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:177
-
Tgstation.Server.Api.Models.EngineVersion.CustomIteration
int? CustomIteration
The revision of the custom build.
Definition EngineVersion.cs:43
+
Tgstation.Server.Api.Models.EngineVersion.ToString
override string ToString()
Definition EngineVersion.cs:179
+
Tgstation.Server.Api.Models.EngineVersion.CustomIteration
int? CustomIteration
The revision of the custom build.
Definition EngineVersion.cs:45
Tgstation.Server.Host.Components.Engine.EngineManager.InstallVersionFiles
async ValueTask< string > InstallVersionFiles(JobProgressReporter progressReporter, EngineVersion version, Stream? customVersionStream, bool deploymentPipelineProcesses, CancellationToken cancellationToken)
Installs the files for a given BYOND version .
Definition EngineManager.cs:541
Tgstation.Server.Host.Components.Engine.EngineManager.AddInstallationContainer
ReferenceCountingContainer< IEngineInstallation, EngineExecutableLock > AddInstallationContainer(IEngineInstallation installation)
Create and add a new IEngineInstallation to installedVersions.
Definition EngineManager.cs:636
Tgstation.Server.Host.Jobs.JobException
Operation exceptions thrown from the context of a Models.Job.
Definition JobException.cs:11
@@ -603,7 +603,7 @@ Here is the caller graph for this function:
Tgstation.Server.Api.Models.ErrorCode
ErrorCode
Types of Response.ErrorMessageResponses that the API may return.
Definition ErrorCode.cs:12
Tgstation.Server.Host.Components.Events.EventType
EventType
Types of events. Mirror in tgs.dm. Prefer last listed name for script.
Definition EventType.cs:7
-

References Tgstation.Server.Host.Components.Engine.EngineManager.AddInstallationContainer(), Tgstation.Server.Host.Utils.ReferenceCountingContainer< TWrapped, TReference >.AddReference(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.CreateInstallation(), Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Host.IO.IIOManager.DeleteDirectory(), Tgstation.Server.Host.Utils.ReferenceCounter< TInstance >.Dispose(), Tgstation.Server.Host.Components.Engine.EngineManager.engineInstaller, Tgstation.Server.Host.Components.Engine.EngineManager.eventConsumer, Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Host.Components.Engine.IEngineInstallation.InstallationTask, Tgstation.Server.Host.Components.Engine.EngineManager.installedVersions, Tgstation.Server.Host.Components.Engine.EngineManager.InstallVersionFiles(), Tgstation.Server.Host.Utils.ReferenceCountingContainer< TWrapped, TReference >.Instance, Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), and Tgstation.Server.Api.Models.EngineVersion.ToString().

+

References Tgstation.Server.Host.Components.Engine.EngineManager.AddInstallationContainer(), Tgstation.Server.Host.Utils.ReferenceCountingContainer< TWrapped, TReference >.AddReference(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.CreateInstallation(), Tgstation.Server.Api.Models.EngineVersion.CustomIteration, Tgstation.Server.Host.IO.IIOManager.DeleteDirectory(), Tgstation.Server.Host.Utils.ReferenceCounter< TInstance >.Dispose(), Tgstation.Server.Host.Components.Engine.EngineManager.engineInstaller, Tgstation.Server.Host.Components.Engine.EngineManager.eventConsumer, Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Host.Components.Engine.IEngineInstallation.InstallationTask, Tgstation.Server.Host.Components.Engine.EngineManager.installedVersions, Tgstation.Server.Host.Components.Engine.EngineManager.InstallVersionFiles(), Tgstation.Server.Host.Utils.ReferenceCountingContainer< TWrapped, TReference >.Instance, Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), and Tgstation.Server.Api.Models.EngineVersion.ToString().

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.ChangeVersion(), and Tgstation.Server.Host.Components.Engine.EngineManager.UseExecutables().

@@ -773,7 +773,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock
static async ValueTask< SemaphoreSlimContext > Lock(SemaphoreSlim semaphore, CancellationToken cancellationToken, ILogger? logger=null)
Asyncronously locks a semaphore .
Definition SemaphoreSlimContext.cs:21
Tgstation.Server.Host.IO.IIOManager.WriteAllBytes
ValueTask WriteAllBytes(string path, byte[] contents, CancellationToken cancellationToken)
Writes some contents to a file at path overwriting previous content.
-

References Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersion, Tgstation.Server.Host.Components.Engine.EngineManager.activeVersionChanged, Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersionFileName, Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.changeDeleteSemaphore, Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Host.Components.Engine.EngineManager.eventConsumer, Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock(), Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

+

References Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersion, Tgstation.Server.Host.Components.Engine.EngineManager.activeVersionChanged, Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersionFileName, Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.changeDeleteSemaphore, Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Host.Components.Engine.EngineManager.eventConsumer, Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock(), Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

Here is the call graph for this function:
@@ -878,7 +878,7 @@ Here is the call graph for this function:
95 }
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
-

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, and Tgstation.Server.Api.Models.EngineVersion.Engine.

+

References Tgstation.Server.Api.Models.EngineVersion.CustomIteration, and Tgstation.Server.Api.Models.EngineVersion.Engine.

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.ChangeVersion(), and Tgstation.Server.Host.Components.Engine.EngineManager.DeleteVersion().

@@ -1046,13 +1046,13 @@ Here is the caller graph for this function:
296 }
297 }
298 }
-
Tgstation.Server.Api.Models.EngineVersion.Equals
bool Equals(EngineVersion other)
Definition EngineVersion.cs:158
+
Tgstation.Server.Api.Models.EngineVersion.Equals
bool Equals(EngineVersion other)
Definition EngineVersion.cs:160
Tgstation.Server.Host.Components.Engine.EngineManager.VersionFileName
const string VersionFileName
The file in which we store the Version for installations.
Definition EngineManager.cs:27
Tgstation.Server.Host.Utils.ReferenceCountingContainer.OnZeroReferences
Task OnZeroReferences
A Task that completes when there are no TReference s active for the Instance.
Definition ReferenceCountingContainer.cs:24
Tgstation.Server.Host.IO.IIOManager.ConcatPath
string ConcatPath(params string[] paths)
Combines an array of strings into a path.
Tgstation.Server.Host.IO.IIOManager.DeleteFile
Task DeleteFile(string path, CancellationToken cancellationToken)
Deletes a file at path .
-

References Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersion, Tgstation.Server.Host.Components.Engine.EngineManager.activeVersionChanged, Tgstation.Server.Host.Components.Engine.EngineManager.changeDeleteSemaphore, Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.DeleteDirectory(), Tgstation.Server.Host.IO.IIOManager.DeleteFile(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Engine.EngineManager.installedVersions, Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock(), Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Host.Utils.ReferenceCountingContainer< TWrapped, TReference >.OnZeroReferences, Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Host.Components.Engine.EngineManager.VersionFileName.

+

References Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersion, Tgstation.Server.Host.Components.Engine.EngineManager.activeVersionChanged, Tgstation.Server.Host.Components.Engine.EngineManager.changeDeleteSemaphore, Tgstation.Server.Host.Components.Engine.EngineManager.CheckVersionParameter(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.DeleteDirectory(), Tgstation.Server.Host.IO.IIOManager.DeleteFile(), Tgstation.Server.Api.Models.EngineVersion.Equals(), Tgstation.Server.Host.Components.Engine.EngineManager.installedVersions, Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock(), Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Host.Utils.ReferenceCountingContainer< TWrapped, TReference >.OnZeroReferences, Tgstation.Server.Api.Models.EngineVersion.ToString(), and Tgstation.Server.Host.Components.Engine.EngineManager.VersionFileName.

Here is the call graph for this function:
@@ -1268,7 +1268,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Components.Engine.IEngineInstaller.Install
ValueTask Install(EngineVersion version, string path, bool deploymentPipelineProcesses, CancellationToken cancellationToken)
Does actions necessary to get an extracted installation working.
Tgstation.Server.Host.IO.IIOManager.CreateDirectory
Task CreateDirectory(string path, CancellationToken cancellationToken)
Create a directory at path .
-

References Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.CreateDirectory(), Tgstation.Server.Host.Jobs.JobProgressReporter.CreateSection(), Tgstation.Server.Host.IO.IIOManager.DeleteDirectory(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.DownloadVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.engineInstaller, Tgstation.Server.Host.Components.Engine.IEngineInstallationData.ExtractToPath(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.Install(), Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Host.Jobs.JobProgressReporter.ReportProgress(), Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Host.Components.Engine.EngineManager.VersionFileName, and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

+

References Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.CreateDirectory(), Tgstation.Server.Host.Jobs.JobProgressReporter.CreateSection(), Tgstation.Server.Host.IO.IIOManager.DeleteDirectory(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.DownloadVersion(), Tgstation.Server.Host.Components.Engine.EngineManager.engineInstaller, Tgstation.Server.Host.Components.Engine.IEngineInstallationData.ExtractToPath(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.Install(), Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Host.Jobs.JobProgressReporter.ReportProgress(), Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Host.Components.Engine.EngineManager.VersionFileName, and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

Referenced by Tgstation.Server.Host.Components.Engine.EngineManager.AssertAndLockVersion().

@@ -1426,7 +1426,7 @@ Here is the caller graph for this function:
385 }
386 }
387 }
-
Tgstation.Server.Api.Models.EngineVersion.TryParse
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
Definition EngineVersion.cs:51
+
Tgstation.Server.Api.Models.EngineVersion.TryParse
static bool TryParse(string input, out EngineVersion? engineVersion)
Attempts to parse a stringified EngineVersion.
Definition EngineVersion.cs:53
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
Tgstation.Server.Host.IO.DefaultIOManager
IIOManager that resolves paths to Environment.CurrentDirectory.
Definition DefaultIOManager.cs:17
@@ -1436,7 +1436,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.IO.IIOManager.GetDirectories
Task< IReadOnlyList< string > > GetDirectories(string path, CancellationToken cancellationToken)
Returns full directory names in a given path .
Tgstation.Server.Host.IO.IIOManager.FileExists
Task< bool > FileExists(string path, CancellationToken cancellationToken)
Check that the file at path exists.
-

References Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersion, Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersionFileName, Tgstation.Server.Host.Components.Engine.EngineManager.AddInstallationContainer(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.CreateDirectory(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.CreateInstallation(), Tgstation.Server.Host.IO.DefaultIOManager.CurrentDirectory, Tgstation.Server.Host.IO.IIOManager.DeleteDirectory(), Tgstation.Server.Host.IO.IIOManager.DeleteFile(), Tgstation.Server.Host.Components.Engine.EngineManager.engineInstaller, Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.IO.IIOManager.GetDirectories(), Tgstation.Server.Host.Components.Engine.EngineManager.installedVersions, Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Host.IO.IIOManager.ReadAllBytes(), Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Api.Models.EngineVersion.TryParse(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.UpgradeInstallation(), Tgstation.Server.Host.Components.Engine.EngineManager.VersionFileName, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

+

References Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersion, Tgstation.Server.Host.Components.Engine.EngineManager.ActiveVersionFileName, Tgstation.Server.Host.Components.Engine.EngineManager.AddInstallationContainer(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.CreateDirectory(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.CreateInstallation(), Tgstation.Server.Host.IO.DefaultIOManager.CurrentDirectory, Tgstation.Server.Host.IO.IIOManager.DeleteDirectory(), Tgstation.Server.Host.IO.IIOManager.DeleteFile(), Tgstation.Server.Host.Components.Engine.EngineManager.engineInstaller, Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.IO.IIOManager.GetDirectories(), Tgstation.Server.Host.Components.Engine.EngineManager.installedVersions, Tgstation.Server.Host.Components.Engine.EngineManager.ioManager, Tgstation.Server.Host.Components.Engine.EngineManager.logger, Tgstation.Server.Host.IO.IIOManager.ReadAllBytes(), Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Api.Models.EngineVersion.ToString(), Tgstation.Server.Api.Models.EngineVersion.TryParse(), Tgstation.Server.Host.Components.Engine.IEngineInstaller.UpgradeInstallation(), Tgstation.Server.Host.Components.Engine.EngineManager.VersionFileName, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

Referenced by Tgstation.Server.Host.Components.Instance.StartAsync().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_open_dream_installation.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_open_dream_installation.html index 2e26a830b4..6b42c43ad3 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_open_dream_installation.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_open_dream_installation.html @@ -515,8 +515,8 @@ Additional Inherited Members
124 var parametersString = EncodeParameters(parameters, launchParameters);
125
126 var arguments = $"{serverDllPath} --cvar {(logFilePath != null ? $"log.path=\"{InstallationIOManager.GetDirectoryName(logFilePath)}\" --cvar log.format=\"{InstallationIOManager.GetFileName(logFilePath)}\"" : "log.enabled=false")} --cvar watchdog.token={accessIdentifier} --cvar log.runtimelog=false --cvar net.port={launchParameters.Port!.Value} --cvar opendream.topic_port={launchParameters.OpenDreamTopicPort!.Value} --cvar opendream.world_params=\"{parametersString}\" --cvar opendream.json_path=\"./{dmbProvider.DmbName}\"";
-
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
-
ushort? OpenDreamTopicPort
The port used by EngineType.OpenDream for its topic port.
+
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
+
ushort? OpenDreamTopicPort
The port used by EngineType.OpenDream for its topic port.
static string EncodeParameters(IReadOnlyDictionary< string, string > parameters, DreamDaemonLaunchParameters launchParameters)
Encode given parameters for passing as world.params on the command line.
return arguments
Constants used for communication with the DMAPI.
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_posix_byond_installer.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_posix_byond_installer.html index 61a6183c70..a056fc2d08 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_posix_byond_installer.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_posix_byond_installer.html @@ -598,7 +598,7 @@ Here is the caller graph for this function:
109
110 return task;
111 }
-
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:30
+
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:31
Tgstation.Server.Common.Extensions.ValueTaskExtensions
Extension methods for the ValueTask and ValueTask<TResult> classes.
Definition ValueTaskExtensions.cs:12
Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll
static async ValueTask WhenAll(IEnumerable< ValueTask > tasks)
Fully await a given list of tasks .
Definition ValueTaskExtensions.cs:99
Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath
const string ByondBinPath
The path to the BYOND bin folder.
Definition ByondInstallerBase.cs:24
@@ -610,7 +610,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.IO.IIOManager.WriteAllBytes
ValueTask WriteAllBytes(string path, byte[] contents, CancellationToken cancellationToken)
Writes some contents to a file at path overwriting previous content.
Tgstation.Server.Host.IO.IPostWriteHandler.HandleWrite
void HandleWrite(string filePath)
For handling system specific necessities after a write.
-

References Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Engine.PosixByondInstaller.DreamDaemonExecutableName, Tgstation.Server.Host.Components.Engine.PosixByondInstaller.DreamMakerExecutableName, Tgstation.Server.Host.Components.Engine.PosixByondInstaller.DreamMakerName, Tgstation.Server.Host.Components.Engine.PosixByondInstaller.GetDreamDaemonName(), Tgstation.Server.Host.IO.IPostWriteHandler.HandleWrite(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.IOManager, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.Logger, Tgstation.Server.Host.Components.Engine.PosixByondInstaller.postWriteHandler, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Api.Models.EngineVersion.Version, Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll(), and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

+

References Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Engine.PosixByondInstaller.DreamDaemonExecutableName, Tgstation.Server.Host.Components.Engine.PosixByondInstaller.DreamMakerExecutableName, Tgstation.Server.Host.Components.Engine.PosixByondInstaller.DreamMakerName, Tgstation.Server.Host.Components.Engine.PosixByondInstaller.GetDreamDaemonName(), Tgstation.Server.Host.IO.IPostWriteHandler.HandleWrite(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.IOManager, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.Logger, Tgstation.Server.Host.Components.Engine.PosixByondInstaller.postWriteHandler, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Api.Models.EngineVersion.Version, Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll(), and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_windows_byond_installer.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_windows_byond_installer.html index b209bec2d4..2c73569469 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_windows_byond_installer.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_windows_byond_installer.html @@ -647,7 +647,7 @@ Here is the call graph for this function:
354 cancellationToken);
355 }
Exception
-
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:30
+
Tgstation.Server.Api.Models.EngineVersion.Version
Version? Version
The System.Version of the engine. Currently only valid when Engine is EngineType.Byond.
Definition EngineVersion.cs:31
Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath
const string ByondBinPath
The path to the BYOND bin folder.
Definition ByondInstallerBase.cs:24
Tgstation.Server.Host.Components.Engine.EngineInstallerBase.Logger
ILogger< EngineInstallerBase > Logger
Gets the ILogger for the EngineInstallerBase.
Definition EngineInstallerBase.cs:29
Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.GetDreamDaemonName
override string GetDreamDaemonName(Version byondVersion, out bool supportsCli)
Definition WindowsByondInstaller.cs:225
@@ -659,7 +659,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.IO.IIOManager.WriteAllBytes
ValueTask WriteAllBytes(string path, byte[] contents, CancellationToken cancellationToken)
Writes some contents to a file at path overwriting previous content.
Tgstation.Server.Api.Models.ErrorCode
ErrorCode
Types of Response.ErrorMessageResponses that the API may return.
Definition ErrorCode.cs:12
-

References Tgstation.Server.Host.System.WindowsFirewallHelper.AddFirewallException(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath, Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.GetDreamDaemonName(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.IOManager, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.Logger, Tgstation.Server.Host.Configuration.SessionConfiguration.LowPriorityDeploymentProcesses, Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.processExecutor, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.sessionConfiguration, Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.TgsFirewalledDDFile, Tgstation.Server.Api.Models.EngineVersion.Version, and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

+

References Tgstation.Server.Host.System.WindowsFirewallHelper.AddFirewallException(), Tgstation.Server.Host.Components.Engine.ByondInstallerBase.ByondBinPath, Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.GetDreamDaemonName(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.IOManager, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.Logger, Tgstation.Server.Host.Configuration.SessionConfiguration.LowPriorityDeploymentProcesses, Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.processExecutor, Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.sessionConfiguration, Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.TgsFirewalledDDFile, Tgstation.Server.Api.Models.EngineVersion.Version, and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

Referenced by Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.Install(), and Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.UpgradeInstallation().

@@ -1351,7 +1351,7 @@ Here is the call graph for this function:
178 await AddDreamDaemonToFirewall(version, path, true, cancellationToken);
179 }
-

References Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.AddDreamDaemonToFirewall(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.DDExeVersion, Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.generalConfiguration, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.IOManager, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.Logger, Tgstation.Server.Host.Configuration.GeneralConfiguration.SkipAddingByondFirewallException, Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.TgsFirewalledDDFile, and Tgstation.Server.Api.Models.EngineVersion.Version.

+

References Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.AddDreamDaemonToFirewall(), Tgstation.Server.Host.Components.Engine.EngineInstallerBase.CheckVersionValidity(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.DDExeVersion, Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.generalConfiguration, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.IOManager, Tgstation.Server.Host.Components.Engine.EngineInstallerBase.Logger, Tgstation.Server.Host.Configuration.GeneralConfiguration.SkipAddingByondFirewallException, Tgstation.Server.Host.Components.Engine.WindowsByondInstaller.TgsFirewalledDDFile, and Tgstation.Server.Api.Models.EngineVersion.Version.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance_manager.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance_manager.html index 29ceaf35b0..77999f3cbe 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance_manager.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_instance_manager.html @@ -823,7 +823,7 @@ Here is the caller graph for this function:
670 }
671 }
Exception
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Host.Components.InstanceManager.OnlineInstance
async ValueTask OnlineInstance(Models.Instance metadata, CancellationToken cancellationToken)
Online an IInstance.A ValueTask representing the running operation.
Definition InstanceManager.cs:404
Tgstation.Server.Host.Components.InstanceManager.PreflightChecks
void PreflightChecks()
Check we have a valid system and configuration.
Definition InstanceManager.cs:676
Tgstation.Server.Host.Components.InstanceManager.InitializeSwarm
async ValueTask InitializeSwarm(CancellationToken cancellationToken)
Initializes the connection to the TGS swarm.
Definition InstanceManager.cs:703
@@ -835,7 +835,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.System.IAssemblyInformationProvider.VersionString
string VersionString
A more verbose version of Version.
Definition IAssemblyInformationProvider.cs:30
Tgstation.Server.Api.Rights.ConfigurationRights.List
@ List
User may list files if the Models.Instance allows it.
-

References Tgstation.Server.Host.Jobs.IJobService.Activate(), Tgstation.Server.Host.Components.InstanceManager.assemblyInformationProvider, Tgstation.Server.Host.Components.InstanceManager.console, Tgstation.Server.Host.Components.InstanceManager.databaseContextFactory, Tgstation.Server.Host.Core.IServerControl.Die(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Components.InstanceManager.InitializeSwarm(), Tgstation.Server.Host.Components.InstanceManager.instanceFactory, Tgstation.Server.Host.Database.IDatabaseContext.Instances, Tgstation.Server.Host.Components.InstanceManager.jobService, Tgstation.Server.Host.Components.InstanceManager.logger, Tgstation.Server.Host.Components.InstanceManager.OnlineInstance(), Tgstation.Server.Host.Components.InstanceManager.PreflightChecks(), Tgstation.Server.Host.Components.InstanceManager.readyTcs, Tgstation.Server.Host.Components.InstanceManager.serverControl, Tgstation.Server.Host.IO.IConsole.SetTitle(), Tgstation.Server.Host.Components.InstanceManager.swarmConfiguration, Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext(), and Tgstation.Server.Host.System.IAssemblyInformationProvider.VersionString.

+

References Tgstation.Server.Host.Jobs.IJobService.Activate(), Tgstation.Server.Host.Components.InstanceManager.assemblyInformationProvider, Tgstation.Server.Host.Components.InstanceManager.console, Tgstation.Server.Host.Components.InstanceManager.databaseContextFactory, Tgstation.Server.Host.Core.IServerControl.Die(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Components.InstanceManager.InitializeSwarm(), Tgstation.Server.Host.Components.InstanceManager.instanceFactory, Tgstation.Server.Host.Database.IDatabaseContext.Instances, Tgstation.Server.Host.Components.InstanceManager.jobService, Tgstation.Server.Host.Components.InstanceManager.logger, Tgstation.Server.Host.Components.InstanceManager.OnlineInstance(), Tgstation.Server.Host.Components.InstanceManager.PreflightChecks(), Tgstation.Server.Host.Components.InstanceManager.readyTcs, Tgstation.Server.Host.Components.InstanceManager.serverControl, Tgstation.Server.Host.IO.IConsole.SetTitle(), Tgstation.Server.Host.Components.InstanceManager.swarmConfiguration, Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext(), and Tgstation.Server.Host.System.IAssemblyInformationProvider.VersionString.

Referenced by Tgstation.Server.Host.Components.InstanceManager.StartAsync().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_hub_remote_features.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_hub_remote_features.html index ffb84c955e..7c3ca56b4e 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_hub_remote_features.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_hub_remote_features.html @@ -353,16 +353,16 @@ Private Attributes
104 return testMerge;
105 }
string? AccessToken
The token/password to access the git repository with. Can also be a TGS encoded app private key....
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
-
string? Comment
Optional comment about the test.
-
int Number
The number of the test merge source.
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
string? Comment
Optional comment about the test.
+
int Number
The number of the test merge source.
string RemoteRepositoryOwner
If RemoteGitProvider is not RemoteGitProvider.Unknown this will be set with the owner of the reposito...
ILogger< GitRemoteFeaturesBase > Logger
The ILogger for the GitRemoteFeaturesBase.
string RemoteRepositoryName
If RemoteGitProvider is not RemoteGitProvider.Unknown this will be set with the name of the repositor...
Identifies a repository either by its RepositoryId or Owner and Name.
ValueTask< IGitHubService > CreateService(CancellationToken cancellationToken)
Create a IGitHubService.
-

References Tgstation.Server.Api.Models.RepositorySettings.AccessToken, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Host.Utils.GitHub.IGitHubServiceFactory.CreateService(), Tgstation.Server.Host.Components.Repository.GitHubRemoteFeatures.gitHubServiceFactory, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.Logger, Tgstation.Server.Api.Models.TestMergeParameters.Number, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.RemoteRepositoryName, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.RemoteRepositoryOwner, and Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha.

+

References Tgstation.Server.Api.Models.RepositorySettings.AccessToken, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Host.Utils.GitHub.IGitHubServiceFactory.CreateService(), Tgstation.Server.Host.Components.Repository.GitHubRemoteFeatures.gitHubServiceFactory, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.Logger, Tgstation.Server.Api.Models.TestMergeParameters.Number, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.RemoteRepositoryName, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.RemoteRepositoryOwner, and Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_lab_remote_features.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_lab_remote_features.html index cedd8af487..be5d591011 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_lab_remote_features.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_lab_remote_features.html @@ -330,13 +330,13 @@ Properties
90 }
string? AccessToken
The token/password to access the git repository with. Can also be a TGS encoded app private key....
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
-
string? Comment
Optional comment about the test.
-
int Number
The number of the test merge source.
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
string? Comment
Optional comment about the test.
+
int Number
The number of the test merge source.
const string GitLabUrl
Url for main GitLab site.
ILogger< GitRemoteFeaturesBase > Logger
The ILogger for the GitRemoteFeaturesBase.
-

References Tgstation.Server.Api.Models.RepositorySettings.AccessToken, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Author, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Host.Components.Repository.GitLabRemoteFeatures.GitLabUrl, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.Logger, Tgstation.Server.Api.Models.TestMergeParameters.Number, and Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha.

+

References Tgstation.Server.Api.Models.RepositorySettings.AccessToken, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Author, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Host.Components.Repository.GitLabRemoteFeatures.GitLabUrl, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.Logger, Tgstation.Server.Api.Models.TestMergeParameters.Number, and Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_remote_features_base.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_remote_features_base.html index 08a0a3b5ae..23e62f8a5c 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_remote_features_base.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_git_remote_features_base.html @@ -303,10 +303,10 @@ TestMergeApiBase.MergedAt and 82
83 return result;
84 }
-
Tgstation.Server.Api.Models.TestMergeParameters.Number
int Number
The number of the test merge source.
Definition TestMergeParameters.cs:13
+
Tgstation.Server.Api.Models.TestMergeParameters.Number
int Number
The number of the test merge source.
Definition TestMergeParameters.cs:14
Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.GetTestMergeImpl
ValueTask< Models.TestMerge > GetTestMergeImpl(TestMergeParameters parameters, RepositorySettings repositorySettings, CancellationToken cancellationToken)
Implementation of GetTestMerge(TestMergeParameters, RepositorySettings, CancellationToken).
-

References Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.cachedLookups, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.GetTestMergeImpl(), Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.Logger, and Tgstation.Server.Api.Models.TestMergeParameters.Number.

+

References Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.cachedLookups, Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.GetTestMergeImpl(), Tgstation.Server.Host.Components.Repository.GitRemoteFeaturesBase.Logger, and Tgstation.Server.Api.Models.TestMergeParameters.Number.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_repository.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_repository.html index b415a362c7..b44afb9124 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_repository.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_repository_1_1_repository.html @@ -907,9 +907,9 @@ Here is the caller graph for this function:
370 Status = result.Status,
371 };
372 }
-
Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
Definition TestMergeParameters.cs:20
-
Tgstation.Server.Api.Models.TestMergeParameters.Comment
string? Comment
Optional comment about the test.
Definition TestMergeParameters.cs:27
-
Tgstation.Server.Api.Models.TestMergeParameters.Number
int Number
The number of the test merge source.
Definition TestMergeParameters.cs:13
+
Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
Definition TestMergeParameters.cs:22
+
Tgstation.Server.Api.Models.TestMergeParameters.Comment
string? Comment
Optional comment about the test.
Definition TestMergeParameters.cs:30
+
Tgstation.Server.Api.Models.TestMergeParameters.Number
int Number
The number of the test merge source.
Definition TestMergeParameters.cs:14
Tgstation.Server.Host.Components.Repository.Repository.Reference
string Reference
The current reference the IRepository HEAD is using. This can be a branch or tag.
Definition Repository.cs:74
Tgstation.Server.Host.Components.Repository.Repository.UpdateSubmodules
ValueTask UpdateSubmodules(JobProgressReporter progressReporter, string? username, string? password, bool deploymentPipeline, CancellationToken cancellationToken)
Recusively update all Submodules in the libGitRepo.
Definition Repository.cs:1114
Tgstation.Server.Host.Components.Repository.Repository.UnknownReference
const string UnknownReference
Used when a reference cannot be determined.
Definition Repository.cs:56
@@ -930,7 +930,7 @@ Here is the caller graph for this function:
Tgstation.Server.Api.HeaderErrorTypes.Api
@ Api
The ApiHeaders.ApiVersionHeader header is missing or invalid.
Tgstation.Server.Host.Components.Events.EventType
EventType
Types of events. Mirror in tgs.dm. Prefer last listed name for script.
Definition EventType.cs:7
-

References Tgstation.Server.Host.IO.DefaultIOManager.BlockingTaskCreationOptions, Tgstation.Server.Host.Components.Repository.ICredentialsProvider.CheckBadCredentialsException(), Tgstation.Server.Host.Components.Repository.Repository.commands, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Host.Jobs.JobProgressReporter.CreateSection(), Tgstation.Server.Host.Components.Repository.Repository.credentialsProvider, Tgstation.Server.Host.Components.Repository.Repository.eventConsumer, Tgstation.Server.Host.Components.Repository.ILibGit2Commands.Fetch(), Tgstation.Server.Host.Components.Repository.ICredentialsProvider.GenerateCredentialsHandler(), Tgstation.Server.Host.Components.Repository.Repository.gitRemoteFeatures, Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Host.Components.Repository.IRepository.Head, Tgstation.Server.Host.Components.Repository.Repository.libGitRepo, Tgstation.Server.Host.Components.Repository.Repository.logger, Tgstation.Server.Api.Models.TestMergeParameters.Number, Tgstation.Server.Host.Components.Repository.Repository.RawCheckout(), Tgstation.Server.Host.Components.Repository.Repository.Reference, Tgstation.Server.Host.Jobs.JobProgressReporter.ReportProgress(), Tgstation.Server.Host.Components.Repository.TestMergeResult.Status, Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha, Tgstation.Server.Host.Components.Repository.IGitRemoteFeatures.TestMergeLocalBranchNameFormatter, Tgstation.Server.Host.Components.Repository.IGitRemoteFeatures.TestMergeRefSpecFormatter, Tgstation.Server.Host.Components.Repository.Repository.UnknownReference, and Tgstation.Server.Host.Components.Repository.Repository.UpdateSubmodules().

+

References Tgstation.Server.Host.IO.DefaultIOManager.BlockingTaskCreationOptions, Tgstation.Server.Host.Components.Repository.ICredentialsProvider.CheckBadCredentialsException(), Tgstation.Server.Host.Components.Repository.Repository.commands, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Host.Jobs.JobProgressReporter.CreateSection(), Tgstation.Server.Host.Components.Repository.Repository.credentialsProvider, Tgstation.Server.Host.Components.Repository.Repository.eventConsumer, Tgstation.Server.Host.Components.Repository.ILibGit2Commands.Fetch(), Tgstation.Server.Host.Components.Repository.ICredentialsProvider.GenerateCredentialsHandler(), Tgstation.Server.Host.Components.Repository.Repository.gitRemoteFeatures, Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Host.Components.Repository.IRepository.Head, Tgstation.Server.Host.Components.Repository.Repository.libGitRepo, Tgstation.Server.Host.Components.Repository.Repository.logger, Tgstation.Server.Api.Models.TestMergeParameters.Number, Tgstation.Server.Host.Components.Repository.Repository.RawCheckout(), Tgstation.Server.Host.Components.Repository.Repository.Reference, Tgstation.Server.Host.Jobs.JobProgressReporter.ReportProgress(), Tgstation.Server.Host.Components.Repository.TestMergeResult.Status, Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha, Tgstation.Server.Host.Components.Repository.IGitRemoteFeatures.TestMergeLocalBranchNameFormatter, Tgstation.Server.Host.Components.Repository.IGitRemoteFeatures.TestMergeRefSpecFormatter, Tgstation.Server.Host.Components.Repository.Repository.UnknownReference, and Tgstation.Server.Host.Components.Repository.Repository.UpdateSubmodules().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_session_1_1_session_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_session_1_1_session_controller.html index a1de376ef0..3b30643827 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_session_1_1_session_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_session_1_1_session_controller.html @@ -742,7 +742,7 @@ Additional Inherited Members
IBridgeRegistration RegisterHandler(IBridgeHandler bridgeHandler)
Register a given bridgeHandler .
Task< int?> Lifetime
The Task<TResult> resulting in the exit code of the process or null if the process was detached.
-

References Tgstation.Server.Host.Components.Interop.DMApiParameters.AccessIdentifier, Tgstation.Server.Host.Components.Session.SessionController.apiValidationSession, Tgstation.Server.Host.Components.Session.SessionController.apiValidationStatus, Tgstation.Server.Host.Components.Session.SessionController.asyncDelayer, Tgstation.Server.Host.Components.Session.SessionController.bridgeRegistration, Tgstation.Server.Host.Components.Session.SessionController.byondTopicSender, Tgstation.Server.Host.Components.Session.SessionController.chat, Tgstation.Server.Host.Components.Session.SessionController.chatTrackingContext, Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.Components.Session.SessionController.customEventProcessingTask, Tgstation.Server.Host.Components.Session.SessionController.disposed, Tgstation.Server.Host.Components.Session.SessionController.DMApiAvailable, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.Components.Session.ReattachInformation.Dmb, Tgstation.Server.Host.Components.Session.SessionController.dotnetDumpService, Tgstation.Server.Host.Components.Session.SessionController.engineLock, Tgstation.Server.Host.Components.Session.SessionController.eventConsumer, Tgstation.Server.Host.Components.Session.SessionController.GetLaunchResult(), Tgstation.Server.Host.Components.Session.SessionController.initialBridgeRequestTcs, Tgstation.Server.Host.Components.Session.SessionController.Lifetime, Tgstation.Server.Host.System.IProcessBase.Lifetime, Tgstation.Server.Host.Components.Session.SessionController.metadata, Tgstation.Server.Host.Models.ReattachInformationBase.Port, Tgstation.Server.Host.Components.Session.SessionController.postValidationShutdownTask, Tgstation.Server.Host.Components.Session.SessionController.primeTcs, Tgstation.Server.Host.Components.Session.SessionController.process, Tgstation.Server.Host.Components.Session.SessionController.rebootGate, Tgstation.Server.Host.Components.Session.SessionController.rebootTcs, Tgstation.Server.Host.Components.Interop.Bridge.IBridgeRegistrar.RegisterHandler(), Tgstation.Server.Host.Components.Session.SessionController.released, Tgstation.Server.Host.Components.Session.SessionController.sessionDurationCts, Tgstation.Server.Host.Components.Chat.IChatTrackingContext.SetChannelSink(), Tgstation.Server.Host.Components.Session.SessionController.startupTcs, Tgstation.Server.Host.Components.Session.SessionController.synchronizationLock, and Tgstation.Server.Host.Components.Session.SessionController.TopicSendSemaphore.

+

References Tgstation.Server.Host.Components.Interop.DMApiParameters.AccessIdentifier, Tgstation.Server.Host.Components.Session.SessionController.apiValidationSession, Tgstation.Server.Host.Components.Session.SessionController.apiValidationStatus, Tgstation.Server.Host.Components.Session.SessionController.asyncDelayer, Tgstation.Server.Host.Components.Session.SessionController.bridgeRegistration, Tgstation.Server.Host.Components.Session.SessionController.byondTopicSender, Tgstation.Server.Host.Components.Session.SessionController.chat, Tgstation.Server.Host.Components.Session.SessionController.chatTrackingContext, Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.Components.Session.SessionController.customEventProcessingTask, Tgstation.Server.Host.Components.Session.SessionController.disposed, Tgstation.Server.Host.Components.Session.SessionController.DMApiAvailable, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.Components.Session.ReattachInformation.Dmb, Tgstation.Server.Host.Components.Session.SessionController.dotnetDumpService, Tgstation.Server.Host.Components.Session.SessionController.engineLock, Tgstation.Server.Host.Components.Session.SessionController.eventConsumer, Tgstation.Server.Host.Components.Session.SessionController.GetLaunchResult(), Tgstation.Server.Host.Components.Session.SessionController.initialBridgeRequestTcs, Tgstation.Server.Host.Components.Session.SessionController.Lifetime, Tgstation.Server.Host.System.IProcessBase.Lifetime, Tgstation.Server.Host.Components.Session.SessionController.metadata, Tgstation.Server.Host.Models.ReattachInformationBase.Port, Tgstation.Server.Host.Components.Session.SessionController.postValidationShutdownTask, Tgstation.Server.Host.Components.Session.SessionController.primeTcs, Tgstation.Server.Host.Components.Session.SessionController.process, Tgstation.Server.Host.Components.Session.SessionController.rebootGate, Tgstation.Server.Host.Components.Session.SessionController.rebootTcs, Tgstation.Server.Host.Components.Interop.Bridge.IBridgeRegistrar.RegisterHandler(), Tgstation.Server.Host.Components.Session.SessionController.released, Tgstation.Server.Host.Components.Session.SessionController.sessionDurationCts, Tgstation.Server.Host.Components.Chat.IChatTrackingContext.SetChannelSink(), Tgstation.Server.Host.Components.Session.SessionController.startupTcs, Tgstation.Server.Host.Components.Session.SessionController.synchronizationLock, and Tgstation.Server.Host.Components.Session.SessionController.TopicSendSemaphore.

Here is the call graph for this function:
@@ -1274,7 +1274,7 @@ Here is the caller graph for this function:
591 return result;
592 }
Tgstation.Server.Api.Models.Internal.CompileJob
Represents a deployment run.
Definition CompileJob.cs:11
-
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:41
+
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:43
Tgstation.Server.Host.Components.Interop.Bridge.RuntimeInformation.ServerPort
ushort ServerPort
The port the HTTP server is running on.
Definition RuntimeInformation.cs:27
Tgstation.Server.Host.Components.Interop.Topic.TopicParameters
Parameters for a topic request.
Definition TopicParameters.cs:13
Tgstation.Server.Host.Components.Session.ReattachInformation.RuntimeInformation
RuntimeInformation? RuntimeInformation
The Interop.Bridge.RuntimeInformation for the DMAPI.
Definition ReattachInformation.cs:28
@@ -1284,7 +1284,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.System.IProcess.Startup
Task Startup
The Task representing the time until the IProcess becomes "idle".
Definition IProcess.cs:20
Tgstation.Server.Host.Utils.IAsyncDelayer.Delay
ValueTask Delay(TimeSpan timeSpan, CancellationToken cancellationToken)
Create a Task that completes after a given timeSpan .
-

References Tgstation.Server.Host.Components.Session.SessionController.asyncDelayer, Tgstation.Server.Host.Utils.IAsyncDelayer.Delay(), Tgstation.Server.Host.Components.Session.SessionController.disposed, Tgstation.Server.Host.Components.Session.SessionController.DMApiAvailable, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.System.IProcessBase.Lifetime, Tgstation.Server.Host.Components.Interop.Chunker.Logger, Tgstation.Server.Host.Components.Session.SessionController.process, Tgstation.Server.Host.Components.Session.ReattachInformation.RuntimeInformation, Tgstation.Server.Host.Components.Session.SessionController.SendCommand(), Tgstation.Server.Host.Components.Interop.Bridge.RuntimeInformation.ServerPort, Tgstation.Server.Host.Components.Session.SessionController.sessionDurationCts, Tgstation.Server.Host.System.IProcess.Startup, and Tgstation.Server.Host.System.IAssemblyInformationProvider.Version.

+

References Tgstation.Server.Host.Components.Session.SessionController.asyncDelayer, Tgstation.Server.Host.Utils.IAsyncDelayer.Delay(), Tgstation.Server.Host.Components.Session.SessionController.disposed, Tgstation.Server.Host.Components.Session.SessionController.DMApiAvailable, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.System.IProcessBase.Lifetime, Tgstation.Server.Host.Components.Interop.Chunker.Logger, Tgstation.Server.Host.Components.Session.SessionController.process, Tgstation.Server.Host.Components.Session.ReattachInformation.RuntimeInformation, Tgstation.Server.Host.Components.Session.SessionController.SendCommand(), Tgstation.Server.Host.Components.Interop.Bridge.RuntimeInformation.ServerPort, Tgstation.Server.Host.Components.Session.SessionController.sessionDurationCts, Tgstation.Server.Host.System.IProcess.Startup, and Tgstation.Server.Host.System.IAssemblyInformationProvider.Version.

Referenced by Tgstation.Server.Host.Components.Session.SessionController.SessionController().

@@ -2571,7 +2571,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Components.Session.SessionController.SendRawTopic
async ValueTask< CombinedTopicResponse?> SendRawTopic(string queryString, bool priority, CancellationToken cancellationToken)
Send a given queryString to DreamDaemon's /world/Topic.
Definition SessionController.cs:939
Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob
Models.CompileJob CompileJob
The CompileJob of the .dmb.
Definition IDmbProvider.cs:25
-

References Tgstation.Server.Host.Components.Interop.DMApiParameters.AccessIdentifier, Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.Components.Session.ReattachInformation.Dmb, Tgstation.Server.Host.Components.Interop.DMApiResponse.ErrorMessage, Tgstation.Server.Host.Components.Session.SessionController.GenerateQueryString(), Tgstation.Server.Host.Components.Session.CombinedTopicResponse.InteropResponse, Tgstation.Server.Host.Components.Interop.Topic.TopicParameters.IsPriority, Tgstation.Server.Host.Components.Interop.Chunker.Logger, Tgstation.Server.Host.Components.Interop.DMApiConstants.MaximumTopicRequestLength, Tgstation.Server.Host.Components.Interop.Chunker.NextPayloadId, and Tgstation.Server.Host.Components.Session.SessionController.SendRawTopic().

+

References Tgstation.Server.Host.Components.Interop.DMApiParameters.AccessIdentifier, Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.Components.Session.ReattachInformation.Dmb, Tgstation.Server.Host.Components.Interop.DMApiResponse.ErrorMessage, Tgstation.Server.Host.Components.Session.SessionController.GenerateQueryString(), Tgstation.Server.Host.Components.Session.CombinedTopicResponse.InteropResponse, Tgstation.Server.Host.Components.Interop.Topic.TopicParameters.IsPriority, Tgstation.Server.Host.Components.Interop.Chunker.Logger, Tgstation.Server.Host.Components.Interop.DMApiConstants.MaximumTopicRequestLength, Tgstation.Server.Host.Components.Interop.Chunker.NextPayloadId, and Tgstation.Server.Host.Components.Session.SessionController.SendRawTopic().

Referenced by Tgstation.Server.Host.Components.Session.SessionController.SendCommand().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_session_1_1_session_controller_factory.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_session_1_1_session_controller_factory.html index 166482d633..7bc732882f 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_session_1_1_session_controller_factory.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_session_1_1_session_controller_factory.html @@ -1055,15 +1055,15 @@ Here is the caller graph for this function:
393 }
394 }
Tgstation.Server.Api.Models.EngineVersion.Engine
EngineType? Engine
The EngineType.
Definition EngineVersion.cs:24
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:41
-
Tgstation.Server.Api.Models.Internal.CompileJob.MinimumSecurityLevel
DreamDaemonSecurity? MinimumSecurityLevel
The minimum DreamDaemonSecurity required to run the CompileJob's output.
Definition CompileJob.cs:34
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
Definition DreamDaemonLaunchParameters.cs:47
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:31
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput
bool? LogOutput
If process output/error text should be logged.
Definition DreamDaemonLaunchParameters.cs:99
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout
uint? TopicRequestTimeout
The timeout for sending and receiving BYOND topics in milliseconds.
Definition DreamDaemonLaunchParameters.cs:84
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:62
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:39
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:43
+
Tgstation.Server.Api.Models.Internal.CompileJob.MinimumSecurityLevel
DreamDaemonSecurity? MinimumSecurityLevel
The minimum DreamDaemonSecurity required to run the CompileJob's output.
Definition CompileJob.cs:35
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port
ushort? Port
The port DreamDaemon uses. This should be publically accessible.
Definition DreamDaemonLaunchParameters.cs:51
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility
DreamDaemonVisibility? Visibility
The DreamDaemonVisibility level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:33
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput
bool? LogOutput
If process output/error text should be logged.
Definition DreamDaemonLaunchParameters.cs:107
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout
uint? TopicRequestTimeout
The timeout for sending and receiving BYOND topics in milliseconds.
Definition DreamDaemonLaunchParameters.cs:92
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:68
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel
DreamDaemonSecurity? SecurityLevel
The DreamDaemonSecurity level of DreamDaemon. No-op for EngineType.OpenDream.
Definition DreamDaemonLaunchParameters.cs:42
Tgstation.Server.Host.Components.Session.SessionControllerFactory.CheckPagerIsNotRunning
async ValueTask CheckPagerIsNotRunning()
Make sure the BYOND pager is not running.
Definition SessionControllerFactory.cs:648
Tgstation.Server.Host.Components.Session.SessionControllerFactory.LogDDOutput
async ValueTask LogDDOutput(IProcess process, string? outputFilePath, bool cliSupported, bool preserveFile, CancellationToken cancellationToken)
Attempts to log DreamDaemon output.
Definition SessionControllerFactory.cs:575
Tgstation.Server.Host.Components.Session.SessionControllerFactory.CreateRuntimeInformation
RuntimeInformation CreateRuntimeInformation(IDmbProvider dmbProvider, IChatTrackingContext chatTrackingContext, DreamDaemonSecurity securityLevel, DreamDaemonVisibility visibility, bool apiValidateOnly)
Create RuntimeInformation.
@@ -1083,7 +1083,7 @@ Here is the caller graph for this function:
Tgstation.Server.Api.Models.DreamDaemonSecurity
DreamDaemonSecurity
DreamDaemon's security level.
Definition DreamDaemonSecurity.cs:7
Tgstation.Server.Api.Models.EngineType
EngineType
The type of engine the codebase is using.
Definition EngineType.cs:7
-

References Tgstation.Server.Host.Components.Session.SessionControllerFactory.assemblyInformationProvider, Tgstation.Server.Host.Components.Session.SessionControllerFactory.asyncDelayer, Tgstation.Server.Host.Components.Session.SessionControllerFactory.bridgeRegistrar, Tgstation.Server.Host.Components.Session.SessionControllerFactory.chat, Tgstation.Server.Host.Components.Session.SessionControllerFactory.CheckPagerIsNotRunning(), Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.CreateDirectory(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.CreateGameServerProcess(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.CreateRuntimeInformation(), Tgstation.Server.Host.Components.Session.ITopicClientFactory.CreateTopicClient(), Tgstation.Server.Host.Components.Chat.IChatManager.CreateTrackingContext(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.cryptographySuite, Tgstation.Server.Host.Components.Session.SessionControllerFactory.diagnosticsIOManager, Tgstation.Server.Host.Components.Deployment.IDmbProvider.Directory, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.Components.Deployment.IDmbProvider.DmbName, Tgstation.Server.Host.Components.Session.SessionControllerFactory.dotnetDumpService, Tgstation.Server.Host.Components.Session.SessionControllerFactory.DreamDaemonLogsPath, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Host.Components.Session.SessionControllerFactory.engineManager, Tgstation.Server.Host.Components.Deployment.IDmbProvider.EngineVersion, Tgstation.Server.Host.Components.Session.SessionControllerFactory.eventConsumer, Tgstation.Server.Host.Components.Session.SessionControllerFactory.gameIOManager, Tgstation.Server.Host.Security.ICryptographySuite.GetSecureString(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Session.SessionControllerFactory.instance, Tgstation.Server.Host.Components.Session.SessionControllerFactory.LogDDOutput(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.logger, Tgstation.Server.Host.Components.Session.SessionControllerFactory.loggerFactory, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput, Tgstation.Server.Api.Models.Internal.CompileJob.MinimumSecurityLevel, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port, Tgstation.Server.Host.Components.Session.SessionControllerFactory.PortBindTest(), Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout, Tgstation.Server.Host.Components.Session.SessionControllerFactory.topicClientFactory, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout, Tgstation.Server.Host.Components.Engine.IEngineManager.UseExecutables(), and Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility.

+

References Tgstation.Server.Host.Components.Session.SessionControllerFactory.assemblyInformationProvider, Tgstation.Server.Host.Components.Session.SessionControllerFactory.asyncDelayer, Tgstation.Server.Host.Components.Session.SessionControllerFactory.bridgeRegistrar, Tgstation.Server.Host.Components.Session.SessionControllerFactory.chat, Tgstation.Server.Host.Components.Session.SessionControllerFactory.CheckPagerIsNotRunning(), Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.CreateDirectory(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.CreateGameServerProcess(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.CreateRuntimeInformation(), Tgstation.Server.Host.Components.Session.ITopicClientFactory.CreateTopicClient(), Tgstation.Server.Host.Components.Chat.IChatManager.CreateTrackingContext(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.cryptographySuite, Tgstation.Server.Host.Components.Session.SessionControllerFactory.diagnosticsIOManager, Tgstation.Server.Host.Components.Deployment.IDmbProvider.Directory, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.Components.Deployment.IDmbProvider.DmbName, Tgstation.Server.Host.Components.Session.SessionControllerFactory.dotnetDumpService, Tgstation.Server.Host.Components.Session.SessionControllerFactory.DreamDaemonLogsPath, Tgstation.Server.Api.Models.EngineVersion.Engine, Tgstation.Server.Host.Components.Session.SessionControllerFactory.engineManager, Tgstation.Server.Host.Components.Deployment.IDmbProvider.EngineVersion, Tgstation.Server.Host.Components.Session.SessionControllerFactory.eventConsumer, Tgstation.Server.Host.Components.Session.SessionControllerFactory.gameIOManager, Tgstation.Server.Host.Security.ICryptographySuite.GetSecureString(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Session.SessionControllerFactory.instance, Tgstation.Server.Host.Components.Session.SessionControllerFactory.LogDDOutput(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.logger, Tgstation.Server.Host.Components.Session.SessionControllerFactory.loggerFactory, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.LogOutput, Tgstation.Server.Api.Models.Internal.CompileJob.MinimumSecurityLevel, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Port, Tgstation.Server.Host.Components.Session.SessionControllerFactory.PortBindTest(), Tgstation.Server.Host.IO.IIOManager.ResolvePath(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.SecurityLevel, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout, Tgstation.Server.Host.Components.Session.SessionControllerFactory.topicClientFactory, Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.TopicRequestTimeout, Tgstation.Server.Host.Components.Engine.IEngineManager.UseExecutables(), and Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Visibility.

Referenced by Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.InitController().

@@ -1540,7 +1540,7 @@ Here is the caller graph for this function:
482 }
Tgstation.Server.Host.System.IProcessExecutor.GetProcess
IProcess? GetProcess(int id)
Get a IProcess by id .
-

References Tgstation.Server.Host.Components.Session.SessionControllerFactory.assemblyInformationProvider, Tgstation.Server.Host.Components.Session.SessionControllerFactory.asyncDelayer, Tgstation.Server.Host.Components.Session.SessionControllerFactory.bridgeRegistrar, Tgstation.Server.Host.Components.Session.SessionControllerFactory.chat, Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.Components.Session.SessionControllerFactory.CreateRuntimeInformation(), Tgstation.Server.Host.Components.Session.ITopicClientFactory.CreateTopicClient(), Tgstation.Server.Host.Components.Chat.IChatManager.CreateTrackingContext(), Tgstation.Server.Host.Components.Session.ReattachInformation.Dmb, Tgstation.Server.Host.Components.Session.SessionControllerFactory.dotnetDumpService, Tgstation.Server.Host.Components.Session.SessionControllerFactory.engineManager, Tgstation.Server.Host.Components.Deployment.IDmbProvider.EngineVersion, Tgstation.Server.Host.Components.Session.SessionControllerFactory.eventConsumer, Tgstation.Server.Host.System.IProcessExecutor.GetProcess(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Session.SessionControllerFactory.instance, Tgstation.Server.Host.Models.ReattachInformationBase.LaunchSecurityLevel, Tgstation.Server.Host.Models.ReattachInformationBase.LaunchVisibility, Tgstation.Server.Host.Components.Session.SessionControllerFactory.logger, Tgstation.Server.Host.Components.Session.SessionControllerFactory.loggerFactory, Tgstation.Server.Host.Components.Session.SessionControllerFactory.networkPromptReaper, Tgstation.Server.Host.Components.Session.SessionControllerFactory.processExecutor, Tgstation.Server.Host.Models.ReattachInformationBase.ProcessId, Tgstation.Server.Host.System.INetworkPromptReaper.RegisterProcess(), Tgstation.Server.Host.Components.Session.ReattachInformation.SetRuntimeInformation(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.topicClientFactory, Tgstation.Server.Host.Components.Session.ReattachInformation.TopicRequestTimeout, and Tgstation.Server.Host.Components.Engine.IEngineManager.UseExecutables().

+

References Tgstation.Server.Host.Components.Session.SessionControllerFactory.assemblyInformationProvider, Tgstation.Server.Host.Components.Session.SessionControllerFactory.asyncDelayer, Tgstation.Server.Host.Components.Session.SessionControllerFactory.bridgeRegistrar, Tgstation.Server.Host.Components.Session.SessionControllerFactory.chat, Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.Components.Session.SessionControllerFactory.CreateRuntimeInformation(), Tgstation.Server.Host.Components.Session.ITopicClientFactory.CreateTopicClient(), Tgstation.Server.Host.Components.Chat.IChatManager.CreateTrackingContext(), Tgstation.Server.Host.Components.Session.ReattachInformation.Dmb, Tgstation.Server.Host.Components.Session.SessionControllerFactory.dotnetDumpService, Tgstation.Server.Host.Components.Session.SessionControllerFactory.engineManager, Tgstation.Server.Host.Components.Deployment.IDmbProvider.EngineVersion, Tgstation.Server.Host.Components.Session.SessionControllerFactory.eventConsumer, Tgstation.Server.Host.System.IProcessExecutor.GetProcess(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Session.SessionControllerFactory.instance, Tgstation.Server.Host.Models.ReattachInformationBase.LaunchSecurityLevel, Tgstation.Server.Host.Models.ReattachInformationBase.LaunchVisibility, Tgstation.Server.Host.Components.Session.SessionControllerFactory.logger, Tgstation.Server.Host.Components.Session.SessionControllerFactory.loggerFactory, Tgstation.Server.Host.Components.Session.SessionControllerFactory.networkPromptReaper, Tgstation.Server.Host.Components.Session.SessionControllerFactory.processExecutor, Tgstation.Server.Host.Models.ReattachInformationBase.ProcessId, Tgstation.Server.Host.System.INetworkPromptReaper.RegisterProcess(), Tgstation.Server.Host.Components.Session.ReattachInformation.SetRuntimeInformation(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.topicClientFactory, Tgstation.Server.Host.Components.Session.ReattachInformation.TopicRequestTimeout, and Tgstation.Server.Host.Components.Engine.IEngineManager.UseExecutables().

Referenced by Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.InitController().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_advanced_watchdog.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_advanced_watchdog.html index 12f5cd6fd7..5f5de2634c 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_advanced_watchdog.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_advanced_watchdog.html @@ -1176,8 +1176,8 @@ Here is the call graph for this function:
285 pendingSwappable = swappableProvider;
286 }
Exception
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
-
Tgstation.Server.Api.Models.Internal.CompileJob.DmeName
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:16
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
+
Tgstation.Server.Api.Models.Internal.CompileJob.DmeName
string? DmeName
The .dme file used for compilation.
Definition CompileJob.cs:17
Tgstation.Server.Host.Components.Deployment.DmbFactory
Standard IDmbFactory.
Definition DmbFactory.cs:29
Tgstation.Server.Host.Components.Deployment.DmbFactory.LockNextDmb
IDmbProvider LockNextDmb(string reason, [CallerFilePath] string? callerFile=null, [CallerLineNumber] int callerLine=default)
Gets the next IDmbProvider. DmbAvailable is a precondition.A new IDmbProvider.
Definition DmbFactory.cs:195
Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider
A IDmbProvider that uses filesystem links to change directory structure underneath the server process...
Definition SwappableDmbProvider.cs:14
@@ -1188,7 +1188,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Components.Deployment.IDmbProvider
Provides absolute paths to the latest compiled .dmbs.
Definition IDmbProvider.cs:11
Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob
Models.CompileJob CompileJob
The CompileJob of the .dmb.
Definition IDmbProvider.cs:25
-

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveCompileJob, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.CanUseSwappableDmbProvider(), Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.CreateSwappableDmbProvider(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAsync(), Tgstation.Server.Api.Models.Internal.CompileJob.DmeName, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Deployment.DmbFactory.LockNextDmb(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.pendingSwappable, and Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.PerformDmbSwap().

+

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveCompileJob, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.CanUseSwappableDmbProvider(), Tgstation.Server.Host.Components.Deployment.IDmbProvider.CompileJob, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.CreateSwappableDmbProvider(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAsync(), Tgstation.Server.Api.Models.Internal.CompileJob.DmeName, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Deployment.DmbFactory.LockNextDmb(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.pendingSwappable, and Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.PerformDmbSwap().

Here is the call graph for this function:
@@ -1350,7 +1350,7 @@ Here is the call graph for this function:
229 return await base.HandleNormalReboot(cancellationToken);
230 }
IAsyncDisposable
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:62
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout
uint? StartupTimeout
The DreamDaemon startup timeout in seconds.
Definition DreamDaemonLaunchParameters.cs:68
Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.CompileJob
Models.CompileJob CompileJob
The CompileJob of the .dmb.
Definition SwappableDmbProvider.cs:27
Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.FinishActivationPreparation
Task FinishActivationPreparation(CancellationToken cancellationToken)
Should be awaited. before calling MakeActive(CancellationToken) to ensure the SwappableDmbProvider is...
Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.Swapped
bool Swapped
If MakeActive(CancellationToken) has been run.
Definition SwappableDmbProvider.cs:35
@@ -1365,7 +1365,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage
void QueueWatchdogMessage(string message)
Queue a chat message to configured watchdog channels.
Tgstation.Server.Host.Components.Watchdog.MonitorAction
MonitorAction
The action for the monitor loop to take when control is returned to it.
Definition MonitorAction.cs:7
-

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveLaunchParameters, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.ActiveSwappable, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.BeforeApplyDmb(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Chat, Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.CompileJob, Tgstation.Server.Host.Utils.AsyncDelayer.Delay(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.deploymentCleanupGate, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.deploymentCleanupTasks, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.DrainDeploymentCleanupTasks(), Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.FinishActivationPreparation(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.pendingSwappable, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.PerformDmbSwap(), Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage(), Tgstation.Server.Host.Server.Restart(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout, Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.Swapped, and Tgstation.Server.Host.Components.Session.SessionPersistor.Update().

+

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveLaunchParameters, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.ActiveSwappable, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.BeforeApplyDmb(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Chat, Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.CompileJob, Tgstation.Server.Host.Utils.AsyncDelayer.Delay(), Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.deploymentCleanupGate, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.deploymentCleanupTasks, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.DrainDeploymentCleanupTasks(), Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.FinishActivationPreparation(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.pendingSwappable, Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.PerformDmbSwap(), Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage(), Tgstation.Server.Host.Server.Restart(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.StartupTimeout, Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.Swapped, and Tgstation.Server.Host.Components.Session.SessionPersistor.Update().

Here is the call graph for this function:
@@ -1549,7 +1549,7 @@ Here is the caller graph for this function:
410 }
Tgstation.Server.Host.System.IProcessBase.SuspendProcess
void SuspendProcess()
Suspends the process.
-

References Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.CompileJob, Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.FinishActivationPreparation(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, and Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.MakeActive().

+

References Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.CompileJob, Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.FinishActivationPreparation(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, and Tgstation.Server.Host.Components.Deployment.SwappableDmbProvider.MakeActive().

Referenced by Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.HandleNewDmbAvailable(), and Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.HandleNormalReboot().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_basic_watchdog.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_basic_watchdog.html index 981e2cd0e5..f05bafa5ba 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_basic_watchdog.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_basic_watchdog.html @@ -871,10 +871,10 @@ Here is the call graph for this function:
322 await Server.SetRebootState(Session.RebootState.Restart, cancellationToken);
323 }
Tgstation.Server.Api.Models.Internal.CompileJob
Represents a deployment run.
Definition CompileJob.cs:11
-
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:41
+
Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion
virtual ? Version DMApiVersion
The DMAPI Version.
Definition CompileJob.cs:43
Tgstation.Server.Host.Components.Session.ISessionController.SetRebootState
ValueTask< bool > SetRebootState(RebootState newRebootState, CancellationToken cancellationToken)
Attempts to change the current RebootState to newRebootState .
-

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Chat, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.gracefulRebootRequired, and Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage().

+

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Chat, Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.gracefulRebootRequired, and Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage().

Referenced by Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.HandleMonitorWakeup().

@@ -943,7 +943,7 @@ Here is the caller graph for this function:
304 return ValueTask.FromResult(MonitorAction.Continue);
305 }
-

References Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, and Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Status.

+

References Tgstation.Server.Api.Models.Internal.CompileJob.DMApiVersion, and Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Status.

Referenced by Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.HandleMonitorWakeup().

@@ -1074,7 +1074,7 @@ Here is the caller graph for this function:
283 }
284 }
Exception
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Host.Components.Deployment.DmbFactory
Standard IDmbFactory.
Definition DmbFactory.cs:29
Tgstation.Server.Host.Components.Deployment.DmbFactory.LockNextDmb
IDmbProvider LockNextDmb(string reason, [CallerFilePath] string? callerFile=null, [CallerLineNumber] int callerLine=default)
Gets the next IDmbProvider. DmbAvailable is a precondition.A new IDmbProvider.
Definition DmbFactory.cs:195
Tgstation.Server.Host.Components.Session.SessionControllerFactory
Definition SessionControllerFactory.cs:33
@@ -1092,7 +1092,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Components.Watchdog.WatchdogBase.SessionId
long? SessionId
An incrementing ID for representing current server execution.
Definition WatchdogBase.cs:38
Tgstation.Server.Host.Components.Session.ISessionController.ReattachInformation
ReattachInformation ReattachInformation
Gets the Session.ReattachInformation associated with the ISessionController.
Definition ISessionController.cs:50
-

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveLaunchParameters, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.BeforeApplyDmb(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.CheckLaunchResult(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAndNullControllers(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), Tgstation.Server.Host.Components.Deployment.DmbFactory.LockNextDmb(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.PrepServerForLaunch(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.Reattach(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ReattachFailure(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.SessionId, Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.SessionStartupPersist(), and Tgstation.Server.Host.Components.Session.SessionPersistor.Update().

+

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveLaunchParameters, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.BeforeApplyDmb(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.CheckLaunchResult(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAndNullControllers(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Components.Session.SessionControllerFactory.LaunchNew(), Tgstation.Server.Host.Components.Deployment.DmbFactory.LockNextDmb(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.PrepServerForLaunch(), Tgstation.Server.Host.Components.Session.SessionControllerFactory.Reattach(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ReattachFailure(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.SessionId, Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.SessionStartupPersist(), and Tgstation.Server.Host.Components.Session.SessionPersistor.Update().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_watchdog_base.html b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_watchdog_base.html index b0d8900a32..b2a78ce6fe 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_watchdog_base.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_components_1_1_watchdog_1_1_watchdog_base.html @@ -781,13 +781,13 @@ Here is the call graph for this function:
755 await eventTask;
756 }
Exception
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveCompileJob
Models.? CompileJob ActiveCompileJob
Retrieves the Models.CompileJob currently running on the server.
Definition WatchdogBase.cs:71
Tgstation.Server.Host.Components.Deployment.Remote.IRemoteDeploymentManagerFactory.CreateRemoteDeploymentManager
IRemoteDeploymentManager CreateRemoteDeploymentManager(Api.Models.Instance metadata, RemoteGitProvider remoteGitProvider)
Creates a IRemoteDeploymentManager for a given remoteGitProvider .
Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent
ValueTask HandleEvent(EventType eventType, IEnumerable< string?> parameters, bool deploymentPipeline, CancellationToken cancellationToken)
Handle a given eventType .
Tgstation.Server.Host.Components.Events.EventType
EventType
Types of events. Mirror in tgs.dm. Prefer last listed name for script.
Definition EventType.cs:7
-

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveCompileJob, Tgstation.Server.Host.Components.Deployment.Remote.IRemoteDeploymentManagerFactory.CreateRemoteDeploymentManager(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.eventConsumer, Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.metadata, and Tgstation.Server.Host.Components.Watchdog.WatchdogBase.remoteDeploymentManagerFactory.

+

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveCompileJob, Tgstation.Server.Host.Components.Deployment.Remote.IRemoteDeploymentManagerFactory.CreateRemoteDeploymentManager(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.eventConsumer, Tgstation.Server.Host.Components.Events.IEventConsumer.HandleEvent(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.metadata, and Tgstation.Server.Host.Components.Watchdog.WatchdogBase.remoteDeploymentManagerFactory.

Referenced by Tgstation.Server.Host.Components.Watchdog.AdvancedWatchdog.HandleNormalReboot(), and Tgstation.Server.Host.Components.Watchdog.BasicWatchdog.InitController().

@@ -1187,7 +1187,7 @@ Here is the call graph for this function:
1271 Logger.LogInformation("Dumping session to {dumpFileName}...", dumpFileName);
1272 await session.CreateDump(dumpFileName, ActiveLaunchParameters.Minidumps!.Value, cancellationToken);
1273 }
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Minidumps
bool? Minidumps
If minidumps should be taken instead of full dumps.
Definition DreamDaemonLaunchParameters.cs:113
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.Minidumps
bool? Minidumps
If minidumps should be taken instead of full dumps.
Definition DreamDaemonLaunchParameters.cs:121
Tgstation.Server.Host.IO.IIOManager.ResolvePath
string ResolvePath()
Retrieve the full path of the current working directory.
Tgstation.Server.Host.IO.IIOManager.ConcatPath
string ConcatPath(params string[] paths)
Combines an array of strings into a path.
Tgstation.Server.Host.IO.IIOManager.CreateDirectory
Task CreateDirectory(string path, CancellationToken cancellationToken)
Create a directory at path .
@@ -2133,14 +2133,14 @@ Here is the caller graph for this function:
1194
1195 return MonitorAction.Continue;
1196 }
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.DumpOnHealthCheckRestart
bool? DumpOnHealthCheckRestart
If a process core dump should be created prior to restarting the watchdog due to health check failure...
Definition DreamDaemonLaunchParameters.cs:76
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.DumpOnHealthCheckRestart
bool? DumpOnHealthCheckRestart
If a process core dump should be created prior to restarting the watchdog due to health check failure...
Definition DreamDaemonLaunchParameters.cs:83
Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ClientCount
uint? ClientCount
Last known client count queried from the DMAPI. Requires health checks to be enabled to populate.
Definition WatchdogBase.cs:41
Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAndNullControllers
async ValueTask DisposeAndNullControllers(CancellationToken cancellationToken)
Wrapper for DisposeAndNullControllersImpl under a locked context.
Definition WatchdogBase.cs:692
Tgstation.Server.Host.Components.Watchdog.WatchdogBase.healthChecksMissed
int healthChecksMissed
The number of hearbeats missed.
Definition WatchdogBase.cs:179
Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage
void QueueWatchdogMessage(string message)
Queue a chat message to configured watchdog channels.
Tgstation.Server.Host.Components.Watchdog.MonitorAction
MonitorAction
The action for the monitor loop to take when control is returned to it.
Definition MonitorAction.cs:7
-

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveLaunchParameters, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Chat, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ClientCount, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.CreateDumpNoLock(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAndNullControllers(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.DumpOnHealthCheckRestart, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.GetActiveController(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.healthChecksMissed, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, and Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage().

+

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveLaunchParameters, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Chat, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ClientCount, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.CreateDumpNoLock(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAndNullControllers(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.DumpOnHealthCheckRestart, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.GetActiveController(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.healthChecksMissed, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, and Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage().

Referenced by Tgstation.Server.Host.Components.Watchdog.WatchdogBase.MonitorLifetimes().

@@ -3172,7 +3172,7 @@ Here is the caller graph for this function:
1064
1065 Logger.LogTrace("Monitor exiting...");
1066 }
-
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.HealthCheckSeconds
uint? HealthCheckSeconds
The number of seconds between each watchdog health check. 0 disables.
Definition DreamDaemonLaunchParameters.cs:69
+
Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.HealthCheckSeconds
uint? HealthCheckSeconds
The number of seconds between each watchdog health check. 0 disables.
Definition DreamDaemonLaunchParameters.cs:76
Tgstation.Server.Host.Components.Watchdog.WatchdogBase.HandleHealthCheck
async ValueTask< MonitorAction > HandleHealthCheck(CancellationToken cancellationToken)
Handles a watchdog health check.
Definition WatchdogBase.cs:1117
Tgstation.Server.Host.Components.Watchdog.WatchdogBase.HandleMonitorWakeup
ValueTask< MonitorAction > HandleMonitorWakeup(MonitorActivationReason activationReason, CancellationToken cancellationToken)
Handles the actions to take when the monitor has to "wake up".
Tgstation.Server.Host.Components.Watchdog.WatchdogBase.MonitorRestart
async ValueTask MonitorRestart(CancellationToken cancellationToken)
Attempt to restart the monitor from scratch.
Definition WatchdogBase.cs:787
@@ -3182,7 +3182,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Components.Session.ISessionController
Handles communication with a DreamDaemon IProcess.
Definition ISessionController.cs:16
Tgstation.Server.Host.Components.Watchdog.MonitorActivationReason
MonitorActivationReason
Reasons for the monitor to wake up.
Definition MonitorActivationReason.cs:7
-

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveLaunchParameters, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.activeParametersUpdated, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Chat, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAndNullControllers(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.disposed, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.GetActiveController(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.HandleHealthCheck(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.HandleMonitorWakeup(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.HealthCheckSeconds, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.InitialCheckDmbUpdated(), Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.MonitorRestart(), Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.releaseServers, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Status, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.synchronizationSemaphore, and Tgstation.Server.Host.Utils.SerilogContextHelper.WatchdogMonitorIterationContextProperty.

+

References Tgstation.Server.Host.Components.Watchdog.WatchdogBase.ActiveLaunchParameters, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.activeParametersUpdated, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Chat, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.DisposeAndNullControllers(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.disposed, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.GetActiveController(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.HandleHealthCheck(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.HandleMonitorWakeup(), Tgstation.Server.Api.Models.Internal.DreamDaemonLaunchParameters.HealthCheckSeconds, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.InitialCheckDmbUpdated(), Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Logger, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.MonitorRestart(), Tgstation.Server.Host.Components.Chat.IChatManager.QueueWatchdogMessage(), Tgstation.Server.Host.Components.Watchdog.WatchdogBase.releaseServers, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.Status, Tgstation.Server.Host.Components.Watchdog.WatchdogBase.synchronizationSemaphore, and Tgstation.Server.Host.Utils.SerilogContextHelper.WatchdogMonitorIterationContextProperty.

Referenced by Tgstation.Server.Host.Components.Watchdog.WatchdogBase.LaunchNoLock().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html b/class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html index 2cbb584ac7..19a0360f43 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_general_configuration.html @@ -259,16 +259,16 @@ Static Private Attributes
168 UserLimit = DefaultUserLimit;
169 UserGroupLimit = DefaultUserGroupLimit;
170 }
-
uint UserGroupLimit
The maximum number of user groups allowed.
-
uint MinimumPasswordLength
Minimum length of database user passwords.
-
uint UserLimit
The maximum number of users allowed.
-
uint InstanceLimit
The maximum number of Instances allowed.
+
uint UserGroupLimit
The maximum number of user groups allowed.
+
uint MinimumPasswordLength
Minimum length of database user passwords.
+
uint UserLimit
The maximum number of users allowed.
+
uint InstanceLimit
The maximum number of Instances allowed.
const uint DefaultMinimumPasswordLength
The default value for ServerInformationBase.MinimumPasswordLength.
const uint DefaultUserLimit
The default value for ServerInformationBase.UserLimit.
const uint DefaultInstanceLimit
The default value for ServerInformationBase.InstanceLimit.
const uint DefaultUserGroupLimit
The default value for ServerInformationBase.UserGroupLimit.
-

References Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultInstanceLimit, Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultMinimumPasswordLength, Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultUserGroupLimit, Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultUserLimit, Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit, Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength, Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit, and Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit.

+

References Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultInstanceLimit, Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultMinimumPasswordLength, Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultUserGroupLimit, Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultUserLimit, Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit, Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength, Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit, and Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_controller.html index 12262a1e1d..e9ea5e9336 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_controller.html @@ -534,7 +534,7 @@ Here is the caller graph for this function:
180 }
Tgstation.Server.Api.ApiHeaders
Represents the header that must be present for every server request.
Definition ApiHeaders.cs:25
Tgstation.Server.Api.ApiHeaders.InstanceId
long? InstanceId
The instance EntityId.Id being accessed.
Definition ApiHeaders.cs:84
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Host.Controllers.ApiController.HeadersIssue
IActionResult HeadersIssue(HeadersException headersException)
Response for missing/Invalid headers.
Definition ApiController.cs:225
Tgstation.Server.Host.Controllers.ApiController.ValidateRequest
virtual ValueTask< IActionResult?> ValidateRequest(CancellationToken cancellationToken)
Performs validation a request.
Tgstation.Server.Host.Security.AuthenticationContext.User
User User
The authenticated user.
Definition AuthenticationContext.cs:16
@@ -546,7 +546,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Utils.SerilogContextHelper.RequestPathContextProperty
const string RequestPathContextProperty
The Serilog.Context.LogContext property name for Models.User Api.Models.EntityId.Ids.
Definition SerilogContextHelper.cs:21
Tgstation.Server.Api.HeaderErrorTypes.UserAgent
@ UserAgent
The Microsoft.Net.Http.Headers.HeaderNames.UserAgent header is missing or invalid.
-

References Tgstation.Server.Api.ApiHeaders.ApiVersion, Tgstation.Server.Host.Utils.ApiHeadersProvider.HeadersException, Tgstation.Server.Host.Controllers.ApiController.HeadersIssue(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.ApiHeaders.InstanceId, Tgstation.Server.Host.Utils.SerilogContextHelper.InstanceIdContextProperty, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Api.ApiHeaders.RawUserAgent, Tgstation.Server.Host.Utils.SerilogContextHelper.RequestPathContextProperty, Tgstation.Server.Host.Controllers.ApiController.requireHeaders, Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Utils.SerilogContextHelper.UserIdContextProperty, Tgstation.Server.Host.Security.AuthenticationContext.Valid, and Tgstation.Server.Host.Controllers.ApiController.ValidateRequest().

+

References Tgstation.Server.Api.ApiHeaders.ApiVersion, Tgstation.Server.Host.Utils.ApiHeadersProvider.HeadersException, Tgstation.Server.Host.Controllers.ApiController.HeadersIssue(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.ApiHeaders.InstanceId, Tgstation.Server.Host.Utils.SerilogContextHelper.InstanceIdContextProperty, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Api.ApiHeaders.RawUserAgent, Tgstation.Server.Host.Utils.SerilogContextHelper.RequestPathContextProperty, Tgstation.Server.Host.Controllers.ApiController.requireHeaders, Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Utils.SerilogContextHelper.UserIdContextProperty, Tgstation.Server.Host.Security.AuthenticationContext.Valid, and Tgstation.Server.Host.Controllers.ApiController.ValidateRequest().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller.html index 7f46b88115..4b9013f3ed 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller.html @@ -460,7 +460,7 @@ Additional Inherited Members

References Tgstation.Server.Host.Utils.ApiHeadersProvider.HeadersException, Tgstation.Server.Host.Controllers.ApiController.HeadersIssue(), and Tgstation.Server.Host.Controllers.ApiRootController.loginAuthority.

-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply().

Here is the call graph for this function:
@@ -592,11 +592,11 @@ Here is the caller graph for this function:
167 }
Tgstation.Server.Api.ApiHeaders.Version
static readonly Version Version
Get the version of the Api the caller is using.
Definition ApiHeaders.cs:69
Tgstation.Server.Api.HeadersException
Thrown when trying to generate ApiHeaders from Microsoft.AspNetCore.Http.Headers.RequestHeaders fails...
Definition HeadersException.cs:9
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit
uint UserGroupLimit
The maximum number of user groups allowed.
Definition ServerInformationBase.cs:28
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
Definition ServerInformationBase.cs:34
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength
uint MinimumPasswordLength
Minimum length of database user passwords.
Definition ServerInformationBase.cs:13
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit
uint UserLimit
The maximum number of users allowed.
Definition ServerInformationBase.cs:23
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit
uint InstanceLimit
The maximum number of Instances allowed.
Definition ServerInformationBase.cs:18
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit
uint UserGroupLimit
The maximum number of user groups allowed.
Definition ServerInformationBase.cs:32
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
Definition ServerInformationBase.cs:39
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength
uint MinimumPasswordLength
Minimum length of database user passwords.
Definition ServerInformationBase.cs:14
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit
uint UserLimit
The maximum number of users allowed.
Definition ServerInformationBase.cs:26
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit
uint InstanceLimit
The maximum number of Instances allowed.
Definition ServerInformationBase.cs:20
Tgstation.Server.Api.Models.Response.ServerInformationResponse
Represents basic server information.
Definition ServerInformationResponse.cs:10
Tgstation.Server.Api.Models.Response.SwarmServerResponse
Definition SwarmServerResponse.cs:9
Tgstation.Server.Host.Components.Interop.DMApiConstants
Constants used for communication with the DMAPI.
Definition DMApiConstants.cs:16
@@ -612,7 +612,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Core.ServerUpdateResult.UpdateInProgress
@ UpdateInProgress
Another update is already in progress.
Tgstation.Server.Host.Swarm.SwarmRegistrationResult.Unauthorized
@ Unauthorized
The swarm private keys didn't match.
-

References Tgstation.Server.Host.Controllers.ApiRootController.assemblyInformationProvider, Tgstation.Server.Host.Utils.ApiHeadersProvider.CreateAuthlessHeaders(), Tgstation.Server.Host.Controllers.ApiRootController.generalConfiguration, Tgstation.Server.Host.Swarm.ISwarmService.GetSwarmServers(), Tgstation.Server.Host.Controllers.ApiController.HeadersIssue(), Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit, Tgstation.Server.Host.Components.Interop.DMApiConstants.InteropVersion, Tgstation.Server.Host.System.IPlatformIdentifier.IsWindows, Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength, Tgstation.Server.Host.Controllers.ApiRootController.oAuthProviders, Tgstation.Server.Host.Controllers.ApiRootController.platformIdentifier, Tgstation.Server.Host.Security.OAuth.IOAuthProviders.ProviderInfos(), Tgstation.Server.Host.Controllers.ApiRootController.serverControl, Tgstation.Server.Host.Controllers.ApiRootController.swarmService, Tgstation.Server.Host.Swarm.Unauthorized, Tgstation.Server.Host.Core.IServerControl.UpdateInProgress, Tgstation.Server.Host.Core.UpdateInProgress, Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit, Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit, Tgstation.Server.Host.Security.AuthenticationContext.Valid, Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths, Tgstation.Server.Api.ApiHeaders.Version, and Tgstation.Server.Host.System.IAssemblyInformationProvider.Version.

+

References Tgstation.Server.Host.Controllers.ApiRootController.assemblyInformationProvider, Tgstation.Server.Host.Utils.ApiHeadersProvider.CreateAuthlessHeaders(), Tgstation.Server.Host.Controllers.ApiRootController.generalConfiguration, Tgstation.Server.Host.Swarm.ISwarmService.GetSwarmServers(), Tgstation.Server.Host.Controllers.ApiController.HeadersIssue(), Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit, Tgstation.Server.Host.Components.Interop.DMApiConstants.InteropVersion, Tgstation.Server.Host.System.IPlatformIdentifier.IsWindows, Tgstation.Server.Api.Models.Internal.ServerInformationBase.MinimumPasswordLength, Tgstation.Server.Host.Controllers.ApiRootController.oAuthProviders, Tgstation.Server.Host.Controllers.ApiRootController.platformIdentifier, Tgstation.Server.Host.Security.OAuth.IOAuthProviders.ProviderInfos(), Tgstation.Server.Host.Controllers.ApiRootController.serverControl, Tgstation.Server.Host.Controllers.ApiRootController.swarmService, Tgstation.Server.Host.Swarm.Unauthorized, Tgstation.Server.Host.Core.IServerControl.UpdateInProgress, Tgstation.Server.Host.Core.UpdateInProgress, Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserGroupLimit, Tgstation.Server.Api.Models.Internal.ServerInformationBase.UserLimit, Tgstation.Server.Host.Security.AuthenticationContext.Valid, Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths, Tgstation.Server.Api.ApiHeaders.Version, and Tgstation.Server.Host.System.IAssemblyInformationProvider.Version.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_chat_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_chat_controller.html index 9ffe0fc0cc..6e066073de 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_chat_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_chat_controller.html @@ -419,7 +419,7 @@ Additional Inherited Members
94 }
ChatProvider
Represents a chat service provider.
-

References Tgstation.Server.Api.Api, Tgstation.Server.Api.Rights.List, and Tgstation.Server.Api.Models.Internal.ChatChannelBase.Tag.

+

References Tgstation.Server.Api.Api, Tgstation.Server.Api.Rights.List, and Tgstation.Server.Api.Models.Internal.ChatChannelBase.Tag.

Referenced by Tgstation.Server.Host.Controllers.ChatController.Create(), and Tgstation.Server.Host.Controllers.ChatController.Update().

@@ -537,10 +537,10 @@ Here is the caller graph for this function:
166
167 ?? this.StatusCode(HttpStatusCode.Created, dbModel.ToApi());
168 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Instance.ChatBotLimit
ushort? ChatBotLimit
The maximum number of chat bots the Instance may contain.
Definition Instance.cs:50
-
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:16
+
Tgstation.Server.Api.Models.NamedEntity.Name
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition NamedEntity.cs:17
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
Tgstation.Server.Host.Controllers.ApiController.StatusCode
StatusCodeResult StatusCode(HttpStatusCode statusCode)
Strongly type calls to ControllerBase.StatusCode(int).
Tgstation.Server.Host.Controllers.ChatController.ConvertApiChatChannel
static Models.ChatChannel ConvertApiChatChannel(Api.Models.ChatChannel api, ChatProvider chatProvider)
Converts api to a ChatChannel.
Definition ChatController.cs:67
@@ -554,7 +554,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.Conflict
@ Conflict
HTTP 409.
Tgstation.Server.Host.OAuthGatewayStatus.Enabled
@ Enabled
The OAuth Gateway is enabled.
-

References Tgstation.Server.Api.Models.Instance.ChatBotLimit, Tgstation.Server.Host.Database.DatabaseContext.ChatBots, Tgstation.Server.Host.Controllers.ChatController.ConvertApiChatChannel(), Tgstation.Server.Host.Enabled, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Api.Models.NamedEntity.Name, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.ChatController.StandardModelChecks(), Tgstation.Server.Host.Controllers.ApiController.StatusCode(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable().

+

References Tgstation.Server.Api.Models.Instance.ChatBotLimit, Tgstation.Server.Host.Database.DatabaseContext.ChatBots, Tgstation.Server.Host.Controllers.ChatController.ConvertApiChatChannel(), Tgstation.Server.Host.Enabled, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Api.Models.NamedEntity.Name, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.ChatController.StandardModelChecks(), Tgstation.Server.Host.Controllers.ApiController.StatusCode(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable().

Here is the call graph for this function:
@@ -680,7 +680,7 @@ Here is the call graph for this function:
Tgstation.Server.Api.Rights.RightsType
RightsType
The type of rights a model uses.
Definition RightsType.cs:7
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.Gone
@ Gone
HTTP 410.
-

References Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Rights.List.

+

References Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Rights.List.

Here is the call graph for this function:
@@ -767,7 +767,7 @@ Here is the call graph for this function:
229 }
Tgstation.Server.Host.Controllers.Results.PaginatableResult
Helper for returning paginated models.
Definition PaginatableResult.cs:14
-

References Tgstation.Server.Host.Database.DatabaseContext.ChatBots, Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Rights.List.

+

References Tgstation.Server.Host.Database.DatabaseContext.ChatBots, Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Rights.List.

Here is the call graph for this function:
@@ -1014,7 +1014,7 @@ Here is the caller graph for this function:
376 }
Tgstation.Server.Host.Database.DatabaseContext.ChatChannels
DbSet< ChatChannel > ChatChannels
The ChatChannels in the DatabaseContext.
Definition DatabaseContext.cs:74
-

References Tgstation.Server.Host.Database.DatabaseContext.ChatBots, Tgstation.Server.Host.Database.DatabaseContext.ChatChannels, Tgstation.Server.Host.Controllers.ChatController.ConvertApiChatChannel(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.ChatController.StandardModelChecks(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable().

+

References Tgstation.Server.Host.Database.DatabaseContext.ChatBots, Tgstation.Server.Host.Database.DatabaseContext.ChatChannels, Tgstation.Server.Host.Controllers.ChatController.ConvertApiChatChannel(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.ChatController.StandardModelChecks(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_dream_daemon_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_dream_daemon_controller.html index 4090e47ef9..d8705d3f10 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_dream_daemon_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_dream_daemon_controller.html @@ -568,7 +568,7 @@ Here is the call graph for this function:
Returns
A ValueTask<TResult> resulting in the IActionResult of the operation.
-

References Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, and Tgstation.Server.Api.Rights.List.

+

References Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, and Tgstation.Server.Api.Rights.List.

Referenced by Tgstation.Server.Host.Controllers.DreamDaemonController.Update().

@@ -777,7 +777,7 @@ Here is the call graph for this function:
255 return await ReadImpl(current, rebootRequired, cancellationToken);
256 });
257 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Internal.InstancePermissionSet.DreamDaemonRights
DreamDaemonRights? DreamDaemonRights
The Rights.DreamDaemonRights of the InstancePermissionSet.
Definition InstancePermissionSet.cs:36
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
@@ -800,7 +800,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.Conflict
@ Conflict
HTTP 409.
Tgstation.Server.Host.Components.Session.RebootState
RebootState
Represents the action to take when /world/Reboot() is called.
Definition RebootState.cs:7
-

References Tgstation.Server.Api.Models.Internal.InstancePermissionSet.DreamDaemonRights, Tgstation.Server.Host.Utils.IPortAllocator.GetAvailablePort(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Controllers.DreamDaemonController.portAllocator, Tgstation.Server.Host.Controllers.DreamDaemonController.ReadImpl(), Tgstation.Server.Host.Database.DatabaseContext.Save(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstance().

+

References Tgstation.Server.Api.Models.Internal.InstancePermissionSet.DreamDaemonRights, Tgstation.Server.Host.Utils.IPortAllocator.GetAvailablePort(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Controllers.DreamDaemonController.portAllocator, Tgstation.Server.Host.Controllers.DreamDaemonController.ReadImpl(), Tgstation.Server.Host.Database.DatabaseContext.Save(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstance().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_dream_maker_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_dream_maker_controller.html index 35e7290e00..26d9b5b849 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_dream_maker_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_dream_maker_controller.html @@ -688,12 +688,12 @@ Here is the call graph for this function:
90
91 return Json(dreamMakerSettings.ToApi());
92 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Host.Database.DatabaseContext
Backend abstract implementation of IDatabaseContext.
Definition DatabaseContext.cs:25
Tgstation.Server.Host.Database.DatabaseContext.DreamMakerSettings
DbSet< DreamMakerSettings > DreamMakerSettings
The Models.DreamMakerSettings in the DatabaseContext.
Definition DatabaseContext.cs:49
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.Gone
@ Gone
HTTP 410.
-

References Tgstation.Server.Host.Database.DatabaseContext.DreamMakerSettings, Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Rights.List.

+

References Tgstation.Server.Host.Database.DatabaseContext.DreamMakerSettings, Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Rights.List.

@@ -856,7 +856,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.BadRequest
@ BadRequest
HTTP 400.
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.Conflict
@ Conflict
HTTP 409.
-

References Tgstation.Server.Api.Models.Internal.InstancePermissionSet.DreamMakerRights, Tgstation.Server.Host.Database.DatabaseContext.DreamMakerSettings, Tgstation.Server.Host.Utils.IPortAllocator.GetAvailablePort(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Controllers.DreamMakerController.portAllocator, Tgstation.Server.Api.Rights.Read, and Tgstation.Server.Host.Database.DatabaseContext.Save().

+

References Tgstation.Server.Api.Models.Internal.InstancePermissionSet.DreamMakerRights, Tgstation.Server.Host.Database.DatabaseContext.DreamMakerSettings, Tgstation.Server.Host.Utils.IPortAllocator.GetAvailablePort(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Controllers.DreamMakerController.portAllocator, Tgstation.Server.Api.Rights.Read, and Tgstation.Server.Host.Database.DatabaseContext.Save().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_engine_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_engine_controller.html index fe60c3c6a1..86dcb75b97 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_engine_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_engine_controller.html @@ -780,7 +780,7 @@ Here is the caller graph for this function:
270 return result.InstallJob != null ? Accepted(result) : Json(result);
271 });
272 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Internal.InstancePermissionSet
Represents a PermissionSets permissions in an Instance.
Definition InstancePermissionSet.cs:13
Tgstation.Server.Api.Models.Internal.InstancePermissionSet.EngineRights
EngineRights? EngineRights
The Rights.EngineRights of the InstancePermissionSet.
Definition InstancePermissionSet.cs:30
Tgstation.Server.Api.Models.Response.EngineInstallResponse
Represents an engine installation job. FileTicketResponse.FileTicket is used to upload custom version...
Definition EngineInstallResponse.cs:7
@@ -796,7 +796,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.BadRequest
@ BadRequest
HTTP 400.
Tgstation.Server.Host.Transfer.FileUploadStreamKind
FileUploadStreamKind
Determines the type of global::System.IO.Stream returned from IFileUploadTicket's created from IFileT...
Definition FileUploadStreamKind.cs:7
-

References Tgstation.Server.Host.Transfer.IFileTransferTicketProvider.CreateUpload(), Tgstation.Server.Api.Models.Internal.InstancePermissionSet.EngineRights, Tgstation.Server.Host.Controllers.EngineController.fileTransferService, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.InstanceRequiredController.Instance, Tgstation.Server.Host.Controllers.EngineController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.EngineController.ValidateEngineVersion(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstance().

+

References Tgstation.Server.Host.Transfer.IFileTransferTicketProvider.CreateUpload(), Tgstation.Server.Api.Models.Internal.InstancePermissionSet.EngineRights, Tgstation.Server.Host.Controllers.EngineController.fileTransferService, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.InstanceRequiredController.Instance, Tgstation.Server.Host.Controllers.EngineController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.EngineController.ValidateEngineVersion(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstance().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_controller.html index 9c2f1a3243..0ffa971b64 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_controller.html @@ -700,11 +700,11 @@ Here is the caller graph for this function:
261 api.Accessible = true; // instances are always accessible by their creator
262 return attached ? Json(api) : this.Created(api);
263 }
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
Definition ServerInformationBase.cs:34
-
Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit
uint InstanceLimit
The maximum number of Instances allowed.
Definition ServerInformationBase.cs:18
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths
List< string >? ValidInstancePaths
Limits the locations instances may be created or attached from.
Definition ServerInformationBase.cs:39
+
Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit
uint InstanceLimit
The maximum number of Instances allowed.
Definition ServerInformationBase.cs:20
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
-
Tgstation.Server.Api.Models.UserName.Name
override? string Name
Definition UserName.cs:11
+
Tgstation.Server.Api.Models.UserName.Name
override? string Name
Definition UserName.cs:12
Tgstation.Server.Host.Controllers.ApiController.Logger
ILogger< ApiController > Logger
The ILogger for the ApiController.
Definition ApiController.cs:71
Tgstation.Server.Host.Controllers.InstanceController.CreateDefaultInstance
async ValueTask< Models.Instance?> CreateDefaultInstance(InstanceCreateRequest initialSettings, CancellationToken cancellationToken)
Creates a default Models.Instance from initialSettings .
Definition InstanceController.cs:744
Tgstation.Server.Host.Controllers.InstanceController.ValidateCronSetting
BadRequestObjectResult? ValidateCronSetting(Api.Models.Instance instance)
Validates a given instance 's Api.Models.Instance.AutoUpdateCron setting.
Definition InstanceController.cs:884
@@ -730,7 +730,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Authority.Core.HttpSuccessResponse.Created
@ Created
HTTP 201.
Tgstation.Server.Host.Authority.PermissionSetLookupType.Id
@ Id
Lookup the Api.Models.EntityId.Id of the Models.PermissionSet.
-

References Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Controllers.InstanceController.CreateDefaultInstance(), Tgstation.Server.Host.IO.IIOManager.CreateDirectory(), Tgstation.Server.Host.IO.DefaultIOManager.CurrentDirectory, Tgstation.Server.Host.IO.IIOManager.DeleteFile(), Tgstation.Server.Host.IO.IIOManager.DirectoryExists(), Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.Controllers.InstanceController.generalConfiguration, Tgstation.Server.Host.IO.IIOManager.GetDirectories(), Tgstation.Server.Host.IO.IIOManager.GetFiles(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Controllers.InstanceController.InstanceAttachFileName, Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit, Tgstation.Server.Host.Security.IPermissionsUpdateNotifyee.InstancePermissionSetCreated(), Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Host.Controllers.InstanceController.ioManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Api.Models.UserName.Name, Tgstation.Server.Host.Controllers.InstanceController.NormalizePath(), Tgstation.Server.Host.IO.IIOManager.PathIsChildOf(), Tgstation.Server.Host.Controllers.InstanceController.permissionsUpdateNotifyee, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.InstanceController.ValidateCronSetting(), and Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths.

+

References Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Controllers.InstanceController.CreateDefaultInstance(), Tgstation.Server.Host.IO.IIOManager.CreateDirectory(), Tgstation.Server.Host.IO.DefaultIOManager.CurrentDirectory, Tgstation.Server.Host.IO.IIOManager.DeleteFile(), Tgstation.Server.Host.IO.IIOManager.DirectoryExists(), Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.Controllers.InstanceController.generalConfiguration, Tgstation.Server.Host.IO.IIOManager.GetDirectories(), Tgstation.Server.Host.IO.IIOManager.GetFiles(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Controllers.InstanceController.InstanceAttachFileName, Tgstation.Server.Api.Models.Internal.ServerInformationBase.InstanceLimit, Tgstation.Server.Host.Security.IPermissionsUpdateNotifyee.InstancePermissionSetCreated(), Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Host.Controllers.InstanceController.ioManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Api.Models.UserName.Name, Tgstation.Server.Host.Controllers.InstanceController.NormalizePath(), Tgstation.Server.Host.IO.IIOManager.PathIsChildOf(), Tgstation.Server.Host.Controllers.InstanceController.permissionsUpdateNotifyee, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.InstanceController.ValidateCronSetting(), and Tgstation.Server.Api.Models.Internal.ServerInformationBase.ValidInstancePaths.

Here is the call graph for this function:
@@ -914,7 +914,7 @@ Here is the call graph for this function:
Tgstation.Server.Api.Models.DreamDaemonSecurity
DreamDaemonSecurity
DreamDaemon's security level.
Definition DreamDaemonSecurity.cs:7
Tgstation.Server.Api.Models.DMApiValidationMode
DMApiValidationMode
The DMAPI validation setting for deployments.
Definition DMApiValidationMode.cs:7
-

References Tgstation.Server.Host.Configuration.GeneralConfiguration.ByondTopicTimeout, Tgstation.Server.Host.Models.Instance.DefaultChatBotLimit, Tgstation.Server.Host.Controllers.InstanceController.generalConfiguration, Tgstation.Server.Host.Utils.IPortAllocator.GetAvailablePort(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Models.DreamMakerSettings.Instance, Tgstation.Server.Host.Controllers.InstanceController.InstanceAdminPermissionSet(), Tgstation.Server.Api.Rights.List, Tgstation.Server.Api.Models.Online, Tgstation.Server.Host.Controllers.InstanceController.portAllocator, and Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration.

+

References Tgstation.Server.Host.Configuration.GeneralConfiguration.ByondTopicTimeout, Tgstation.Server.Host.Models.Instance.DefaultChatBotLimit, Tgstation.Server.Host.Controllers.InstanceController.generalConfiguration, Tgstation.Server.Host.Utils.IPortAllocator.GetAvailablePort(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Models.DreamMakerSettings.Instance, Tgstation.Server.Host.Controllers.InstanceController.InstanceAdminPermissionSet(), Tgstation.Server.Api.Rights.List, Tgstation.Server.Api.Models.Online, Tgstation.Server.Host.Controllers.InstanceController.portAllocator, and Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration.

Referenced by Tgstation.Server.Host.Controllers.InstanceController.Create().

@@ -1042,7 +1042,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.IO.IIOManager.WriteAllBytes
ValueTask WriteAllBytes(string path, byte[] contents, CancellationToken cancellationToken)
Writes some contents to a file at path overwriting previous content.
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.Gone
@ Gone
HTTP 410.
-

References Tgstation.Server.Host.Database.DatabaseContext.CompileJobs, Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.DeleteFile(), Tgstation.Server.Host.IO.IIOManager.DirectoryExists(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Controllers.InstanceController.InstanceAttachFileName, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Host.Controllers.InstanceController.ioManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Database.DatabaseContext.RevInfoTestMerges, Tgstation.Server.Host.Database.DatabaseContext.RevisionInformations, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

+

References Tgstation.Server.Host.Database.DatabaseContext.CompileJobs, Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.IO.IIOManager.DeleteFile(), Tgstation.Server.Host.IO.IIOManager.DirectoryExists(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Controllers.InstanceController.InstanceAttachFileName, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Host.Controllers.InstanceController.ioManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Database.DatabaseContext.RevInfoTestMerges, Tgstation.Server.Host.Database.DatabaseContext.RevisionInformations, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, and Tgstation.Server.Host.IO.IIOManager.WriteAllBytes().

Here is the call graph for this function:
@@ -1161,7 +1161,7 @@ Here is the call graph for this function:
Tgstation.Server.Api.Rights.DreamDaemonRights
DreamDaemonRights
Rights for managing DreamDaemon.
Definition DreamDaemonRights.cs:10
Tgstation.Server.Api.Rights.InstanceManagerRights
InstanceManagerRights
Rights for managing Models.Instances.
Definition InstanceManagerRights.cs:10
-

References Tgstation.Server.Host.Controllers.InstanceController.CheckAccessible(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Api.Models.PermissionSet.InstanceManagerRights, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, and Tgstation.Server.Host.Controllers.ComponentInterfacingController.ValidateInstanceOnlineStatus().

+

References Tgstation.Server.Host.Controllers.InstanceController.CheckAccessible(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Api.Models.PermissionSet.InstanceManagerRights, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, and Tgstation.Server.Host.Controllers.ComponentInterfacingController.ValidateInstanceOnlineStatus().

Here is the call graph for this function:
@@ -1251,7 +1251,7 @@ Here is the call graph for this function:
735 return NoContent();
736 }
-

References Tgstation.Server.Api.Models.PermissionSet.Id, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Controllers.InstanceController.InstanceAdminPermissionSet(), Tgstation.Server.Host.Database.DatabaseContext.InstancePermissionSets, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Host.Database.DatabaseContext.Save(), and Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration.

+

References Tgstation.Server.Api.Models.PermissionSet.Id, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Controllers.InstanceController.InstanceAdminPermissionSet(), Tgstation.Server.Host.Database.DatabaseContext.InstancePermissionSets, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Host.Database.DatabaseContext.Save(), and Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration.

Here is the call graph for this function:
@@ -1439,7 +1439,7 @@ Here is the caller graph for this function:
Tgstation.Server.Api.Models.Response.InstanceResponse
Server response for Instances.
Definition InstanceResponse.cs:7
Tgstation.Server.Host.Controllers.Results.PaginatableResult
Helper for returning paginated models.
Definition PaginatableResult.cs:14
-

References Tgstation.Server.Host.Controllers.InstanceController.CheckAccessible(), Tgstation.Server.Api.Models.PermissionSet.Id, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Api.Models.PermissionSet.InstanceManagerRights, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, and Tgstation.Server.Host.Controllers.ComponentInterfacingController.ValidateInstanceOnlineStatus().

+

References Tgstation.Server.Host.Controllers.InstanceController.CheckAccessible(), Tgstation.Server.Api.Models.PermissionSet.Id, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Api.Models.PermissionSet.InstanceManagerRights, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, and Tgstation.Server.Host.Controllers.ComponentInterfacingController.ValidateInstanceOnlineStatus().

Here is the call graph for this function:
@@ -1797,7 +1797,7 @@ Here is the caller graph for this function:
Tgstation.Server.Api.Rights.RightsType
RightsType
The type of rights a model uses.
Definition RightsType.cs:7
Tgstation.Server.Host.Authority.Core.HttpSuccessResponse.Accepted
@ Accepted
HTTP 202.
-

References Tgstation.Server.Host.Jobs.IJobManager.CancelJob(), Tgstation.Server.Host.Database.DatabaseContext.ChatBots, Tgstation.Server.Host.Controllers.InstanceController.CheckAccessible(), Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.IO.IIOManager.DirectoryExists(), Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Api.Models.PermissionSet.InstanceManagerRights, Tgstation.Server.Host.Controllers.ComponentInterfacingController.InstanceOperations, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Host.Controllers.InstanceController.ioManager, Tgstation.Server.Host.Controllers.InstanceController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Components.IInstanceOperations.MoveInstance(), Tgstation.Server.Host.Controllers.InstanceController.NormalizePath(), Tgstation.Server.Host.Components.IInstanceOperations.OfflineInstance(), Tgstation.Server.Host.Components.IInstanceOperations.OnlineInstance(), Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.InstanceController.ValidateCronSetting(), Tgstation.Server.Host.Controllers.ComponentInterfacingController.ValidateInstanceOnlineStatus(), Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable().

+

References Tgstation.Server.Host.Jobs.IJobManager.CancelJob(), Tgstation.Server.Host.Database.DatabaseContext.ChatBots, Tgstation.Server.Host.Controllers.InstanceController.CheckAccessible(), Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.IO.IIOManager.DirectoryExists(), Tgstation.Server.Host.IO.IIOManager.FileExists(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Api.Models.PermissionSet.InstanceManagerRights, Tgstation.Server.Host.Controllers.ComponentInterfacingController.InstanceOperations, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Host.Controllers.InstanceController.ioManager, Tgstation.Server.Host.Controllers.InstanceController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Components.IInstanceOperations.MoveInstance(), Tgstation.Server.Host.Controllers.InstanceController.NormalizePath(), Tgstation.Server.Host.Components.IInstanceOperations.OfflineInstance(), Tgstation.Server.Host.Components.IInstanceOperations.OnlineInstance(), Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Controllers.InstanceController.swarmConfiguration, Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.InstanceController.ValidateCronSetting(), Tgstation.Server.Host.Controllers.ComponentInterfacingController.ValidateInstanceOnlineStatus(), Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_permission_set_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_permission_set_controller.html index 58390c4e73..22366c9517 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_permission_set_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_permission_set_controller.html @@ -534,10 +534,10 @@ Here is the call graph for this function:
261
262 return numDeleted > 0 ? NoContent() : this.Gone();
263 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Host.Database.DatabaseContext.Instances
DbSet< Instance > Instances
The Instances in the DatabaseContext.
Definition DatabaseContext.cs:34
-

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, and Tgstation.Server.Api.Rights.List.

+

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, and Tgstation.Server.Api.Rights.List.

@@ -593,7 +593,7 @@ Here is the call graph for this function:
237 return Json(permissionSet.ToApi());
238 }
-

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, and Tgstation.Server.Api.Rights.List.

+

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, and Tgstation.Server.Api.Rights.List.

@@ -801,7 +801,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Security.AuthenticationContext.GetRight
ulong GetRight(RightsType rightsType)
Get the value of a given rightsType .The value of rightsType . Note that if InstancePermissionSet is ...
Definition AuthenticationContext.cs:103
Tgstation.Server.Api.Rights.RightsType
RightsType
The type of rights a model uses.
Definition RightsType.cs:7
-

References Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Api.Models.Internal.InstancePermissionSet.PermissionSetId, and Tgstation.Server.Host.Database.DatabaseContext.Save().

+

References Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Database.DatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Security.AuthenticationContext.PermissionSet, Tgstation.Server.Api.Models.Internal.InstancePermissionSet.PermissionSetId, and Tgstation.Server.Host.Database.DatabaseContext.Save().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_job_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_job_controller.html index 19dae6ddd8..d633aada71 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_job_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_job_controller.html @@ -484,7 +484,7 @@ Here is the call graph for this function:
149 var updatedJob = await jobManager.CancelJob(job, AuthenticationContext.User, false, cancellationToken);
150 return updatedJob != null ? Accepted(updatedJob.ToApi()) : this.Gone();
151 }
-
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
Tgstation.Server.Api.Models.EntityId.Id
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Tgstation.Server.Api.Models.Instance
Metadata about a server instance.
Definition Instance.cs:9
Tgstation.Server.Api.Models.Response.ErrorMessageResponse
Represents an error message returned by the server.
Definition ErrorMessageResponse.cs:12
Tgstation.Server.Host.Controllers.ApiController.NotFound
new NotFoundObjectResult NotFound()
Generic 404 response.
@@ -499,7 +499,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Authority.Core.HttpFailureResponse.Conflict
@ Conflict
HTTP 409.
Tgstation.Server.Host.Authority.Core.HttpSuccessResponse.Accepted
@ Accepted
HTTP 202.
-

References Tgstation.Server.Host.Jobs.IJobManager.CancelJob(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.JobController.jobManager, Tgstation.Server.Host.Database.DatabaseContext.Jobs, Tgstation.Server.Host.Controllers.JobController.List(), Tgstation.Server.Host.Controllers.ApiController.NotFound(), and Tgstation.Server.Host.Security.AuthenticationContext.User.

+

References Tgstation.Server.Host.Jobs.IJobManager.CancelJob(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.JobController.jobManager, Tgstation.Server.Host.Database.DatabaseContext.Jobs, Tgstation.Server.Host.Controllers.JobController.List(), Tgstation.Server.Host.Controllers.ApiController.NotFound(), and Tgstation.Server.Host.Security.AuthenticationContext.User.

Here is the call graph for this function:
@@ -577,7 +577,7 @@ Here is the call graph for this function:
179 return Json(api);
180 }
-

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.JobController.jobManager, Tgstation.Server.Host.Database.DatabaseContext.Jobs, Tgstation.Server.Host.Controllers.JobController.List(), Tgstation.Server.Host.Controllers.ApiController.NotFound(), and Tgstation.Server.Host.Jobs.IJobManager.SetJobProgress().

+

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.JobController.jobManager, Tgstation.Server.Host.Database.DatabaseContext.Jobs, Tgstation.Server.Host.Controllers.JobController.List(), Tgstation.Server.Host.Controllers.ApiController.NotFound(), and Tgstation.Server.Host.Jobs.IJobManager.SetJobProgress().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_repository_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_repository_controller.html index 734bb615c9..32acae6f2c 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_repository_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_repository_controller.html @@ -547,7 +547,7 @@ Additional Inherited Members
208 return this.Created(api);
209 });
210 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Metadata about a server instance.
Definition Instance.cs:9
Represents an error message returned by the server.
async ValueTask< IActionResult > WithComponentInstance(Func< IInstanceCore, ValueTask< IActionResult > > action, Models.Instance? instance=null)
Run a given action with the relevant IInstance.
@@ -574,7 +574,7 @@ Additional Inherited Members
@ Created
HTTP 201.
@ Id
Lookup the Api.Models.EntityId.Id of the Models.PermissionSet.
-

References Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.RepositoryController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.RepositoryController.PopulateApi(), Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Models.Job.ToApi(), Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.RepositoryController.ValidateCredentials(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstance().

+

References Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.RepositoryController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.RepositoryController.PopulateApi(), Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Models.Job.ToApi(), Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.RepositoryController.ValidateCredentials(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstance().

Here is the call graph for this function:
@@ -723,7 +723,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Controllers.ApiController.Logger
ILogger< ApiController > Logger
The ILogger for the ApiController.
Definition ApiController.cs:71
Tgstation.Server.Host.Authority.Core.HttpSuccessResponse.Accepted
@ Accepted
HTTP 202.
-

References Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.Components.Repository.RepositoryManager.DeleteRepository(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.RepositoryController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Models.Job.ToApi(), and Tgstation.Server.Host.Security.AuthenticationContext.User.

+

References Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.Components.Repository.RepositoryManager.DeleteRepository(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.RepositoryController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Models.Job.ToApi(), and Tgstation.Server.Host.Security.AuthenticationContext.User.

Here is the call graph for this function:
@@ -926,7 +926,7 @@ Here is the caller graph for this function:
333 });
334 }
-

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.RepositoryController.PopulateApi(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Database.DatabaseContext.Save(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstance().

+

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.RepositoryController.PopulateApi(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Database.DatabaseContext.Save(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstance().

Here is the call graph for this function:
@@ -996,7 +996,7 @@ Here is the call graph for this function:
285 }
Tgstation.Server.Host.Controllers.RepositoryController.CreateRepositoryUpdateService
RepositoryUpdateService CreateRepositoryUpdateService(Models.RepositorySettings currentModel)
Creates a RepositoryUpdateService.
-

References Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.Controllers.RepositoryController.CreateRepositoryUpdateService(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.RepositoryController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Models.Job.ToApi(), and Tgstation.Server.Host.Security.AuthenticationContext.User.

+

References Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.Controllers.RepositoryController.CreateRepositoryUpdateService(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.RepositoryController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.ApiController.Logger, Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Models.Job.ToApi(), and Tgstation.Server.Host.Security.AuthenticationContext.User.

Here is the call graph for this function:
@@ -1220,7 +1220,7 @@ Here is the call graph for this function:
Tgstation.Server.Api.Models.Response.RepositoryResponse
Represents a git repository.
Definition RepositoryResponse.cs:11
Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable
async ValueTask< IActionResult?> WithComponentInstanceNullable(Func< IInstanceCore, ValueTask< IActionResult?> > action, Models.Instance? instance=null)
Run a given action with the relevant IInstance.
Definition ComponentInterfacingController.cs:125
-

References Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.Controllers.RepositoryController.CreateRepositoryUpdateService(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.RepositoryController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.RepositoryController.PopulateApi(), Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.RepositoryController.ValidateCredentials(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable().

+

References Tgstation.Server.Host.Models.Job.Create(), Tgstation.Server.Host.Controllers.RepositoryController.CreateRepositoryUpdateService(), Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Controllers.RepositoryController.jobManager, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Controllers.RepositoryController.PopulateApi(), Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation(), Tgstation.Server.Host.Database.DatabaseContext.RepositorySettings, Tgstation.Server.Host.Database.DatabaseContext.Save(), Tgstation.Server.Host.Security.AuthenticationContext.User, Tgstation.Server.Host.Controllers.RepositoryController.ValidateCredentials(), and Tgstation.Server.Host.Controllers.ComponentInterfacingController.WithComponentInstanceNullable().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_root_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_root_controller.html index 63ff413ecf..7ba132891a 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_root_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_root_controller.html @@ -449,11 +449,11 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Configuration.ControlPanelConfiguration.Enable
bool Enable
If the control panel is enabled.
Definition ControlPanelConfiguration.cs:25
Tgstation.Server.Host.Configuration.GeneralConfiguration.HostApiDocumentation
bool HostApiDocumentation
If the swagger documentation and UI should be made avaiable.
Definition GeneralConfiguration.cs:128
Tgstation.Server.Host.Configuration.InternalConfiguration.EnableGraphQL
bool EnableGraphQL
Enables hosting the experimental GraphQL API in Release builds.
Definition InternalConfiguration.cs:45
-
Tgstation.Server.Host.Utils.SwaggerConfiguration
Implements various filters for Swashbuckle.
Definition SwaggerConfiguration.cs:29
-
Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
Definition SwaggerConfiguration.cs:38
+
Tgstation.Server.Host.Utils.SwaggerConfiguration
Implements various filters for Swashbuckle.
Definition SwaggerConfiguration.cs:30
+
Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
Definition SwaggerConfiguration.cs:39
Tgstation.Server.Host.System.IAssemblyInformationProvider.VersionString
string VersionString
A more verbose version of Version.
Definition IAssemblyInformationProvider.cs:30
-

References Tgstation.Server.Host.Controllers.RootController.assemblyInformationProvider, Tgstation.Server.Host.Controllers.RootController.controlPanelConfiguration, Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension, Tgstation.Server.Host.Configuration.ControlPanelConfiguration.Enable, Tgstation.Server.Host.Configuration.InternalConfiguration.EnableGraphQL, Tgstation.Server.Host.Controllers.RootController.generalConfiguration, Tgstation.Server.Api.Routes.GraphQL, Tgstation.Server.Host.Configuration.GeneralConfiguration.HostApiDocumentation, Tgstation.Server.Host.Controllers.RootController.internalConfiguration, and Tgstation.Server.Host.System.IAssemblyInformationProvider.VersionString.

+

References Tgstation.Server.Host.Controllers.RootController.assemblyInformationProvider, Tgstation.Server.Host.Controllers.RootController.controlPanelConfiguration, Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension, Tgstation.Server.Host.Configuration.ControlPanelConfiguration.Enable, Tgstation.Server.Host.Configuration.InternalConfiguration.EnableGraphQL, Tgstation.Server.Host.Controllers.RootController.generalConfiguration, Tgstation.Server.Api.Routes.GraphQL, Tgstation.Server.Host.Configuration.GeneralConfiguration.HostApiDocumentation, Tgstation.Server.Host.Controllers.RootController.internalConfiguration, and Tgstation.Server.Host.System.IAssemblyInformationProvider.VersionString.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html index 21684bfa1f..9f05899de2 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_swarm_controller.html @@ -666,7 +666,7 @@ Here is the call graph for this function:
97
98 return Json(registrationResult);
99 }
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Host.Properties.MasterVersionsAttribute
Attribute for bringing in the master versions list from MSBuild that aren't embedded into assemblies ...
Definition MasterVersionsAttribute.cs:11
Tgstation.Server.Host.Properties.MasterVersionsAttribute.RawSwarmProtocolVersion
string RawSwarmProtocolVersion
The Version string of the TGS swarm protocol.
Definition MasterVersionsAttribute.cs:47
Tgstation.Server.Host.Properties.MasterVersionsAttribute.Instance
static MasterVersionsAttribute Instance
Return the Assembly's instance of the MasterVersionsAttribute.
Definition MasterVersionsAttribute.cs:15
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html index a0776ee0cf..7f20526fb1 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html @@ -320,7 +320,7 @@ Additional Inherited Members
Returns
A ValueTask<TResult> resulting in the IActionResult of the method.

<response code="200">Started streaming download successfully.</response> <response code="410">The ticket was no longer or was never valid.</response>

-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply().

Here is the caller graph for this function:
@@ -399,7 +399,7 @@ Here is the caller graph for this function:

References Tgstation.Server.Host.Controllers.TransferController.fileTransferService, and Tgstation.Server.Host.Transfer.IFileTransferStreamHandler.SetUploadStream().

-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_user_controller.html b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_user_controller.html index 3d44468065..bfdd8492c4 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_user_controller.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_user_controller.html @@ -393,7 +393,7 @@ Additional Inherited Members
147 this,
148 authority => authority.GetId(id, true, false, cancellationToken));
149 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
Definition User.cs:17
@@ -403,7 +403,7 @@ Additional Inherited Members
RightsType
The type of rights a model uses.
Definition RightsType.cs:7
AdministrationRights
Administration rights for the server.
-

References Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Api.Rights.Read, Tgstation.Server.Host.Security.AuthenticationContext.User, and Tgstation.Server.Host.Controllers.UserController.userAuthority.

+

References Tgstation.Server.Host.Security.AuthenticationContext.GetRight(), Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Api.Rights.Read, Tgstation.Server.Host.Security.AuthenticationContext.User, and Tgstation.Server.Host.Controllers.UserController.userAuthority.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_application.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_application.html index 937075f95f..110eba6165 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_application.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_application.html @@ -567,12 +567,12 @@ Additional Inherited Members
Attribute for bringing in the master versions list from MSBuild that aren't embedded into assemblies ...
string RawWebpanelVersion
The Version string of the control panel version built.
static MasterVersionsAttribute Instance
Return the Assembly's instance of the MasterVersionsAttribute.
-
Implements various filters for Swashbuckle.
-
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
+
Implements various filters for Swashbuckle.
+
const string DocumentationSiteRouteExtension
The path to the hosted documentation site.
For managing IInstances.
Task Ready
Task that completes when the IInstanceManager finishes initializing.
-

References Tgstation.Server.Host.Controllers.ControlPanelController.ControlPanelRoute, Tgstation.Server.Host.Configuration.GeneralConfiguration.CurrentConfigVersion, Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension, Tgstation.Server.Api.Routes.GraphQL, Tgstation.Server.Host.Core.Application.hostingEnvironment, Tgstation.Server.Host.Core.IServerPortProvider.HttpApiPort, Tgstation.Server.Host.Properties.MasterVersionsAttribute.Instance, Tgstation.Server.Host.Components.Interop.DMApiConstants.InteropVersion, Tgstation.Server.Api.Routes.JobsHub, Tgstation.Server.Host.Properties.MasterVersionsAttribute.RawWebpanelVersion, Tgstation.Server.Host.Components.IInstanceManager.Ready, and Tgstation.Server.Host.Core.Application.tokenFactory.

+

References Tgstation.Server.Host.Controllers.ControlPanelController.ControlPanelRoute, Tgstation.Server.Host.Configuration.GeneralConfiguration.CurrentConfigVersion, Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension, Tgstation.Server.Api.Routes.GraphQL, Tgstation.Server.Host.Core.Application.hostingEnvironment, Tgstation.Server.Host.Core.IServerPortProvider.HttpApiPort, Tgstation.Server.Host.Properties.MasterVersionsAttribute.Instance, Tgstation.Server.Host.Components.Interop.DMApiConstants.InteropVersion, Tgstation.Server.Api.Routes.JobsHub, Tgstation.Server.Host.Properties.MasterVersionsAttribute.RawWebpanelVersion, Tgstation.Server.Host.Components.IInstanceManager.Ready, and Tgstation.Server.Host.Core.Application.tokenFactory.

@@ -1240,7 +1240,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Utils.PortAllocator
Definition PortAllocator.cs:21
Tgstation.Server.Host.Utils.SerilogContextHelper
Helpers for manipulating the Serilog.Context.LogContext.
Definition SerilogContextHelper.cs:7
Tgstation.Server.Host.Utils.SerilogContextHelper.Template
static string Template
Common template used for adding our custom log context to serilog.
Definition SerilogContextHelper.cs:62
-
Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure
static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)
Configure the swagger settings.
Definition SwaggerConfiguration.cs:61
+
Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure
static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)
Configure the swagger settings.
Definition SwaggerConfiguration.cs:62
Tgstation.Server.Shared.VersionConverter
JsonConverter and IYamlTypeConverter for serializing global::System.Versions in semver format.
Definition VersionConverter.cs:17
Tgstation.Server.Api.Hubs.IJobsHub
SignalR client methods for receiving JobResponses.
Definition IJobsHub.cs:12
Tgstation.Server.Common.Http.IAbstractHttpClientFactory
Creates IHttpClients.
Definition IAbstractHttpClientFactory.cs:7
@@ -1300,7 +1300,7 @@ Here is the caller graph for this function:
Tgstation.Server.Api.Models.EngineType
EngineType
The type of engine the codebase is using.
Definition EngineType.cs:7
Tgstation.Server.Host.Configuration.DatabaseType
DatabaseType
Type of database to user.
Definition DatabaseType.cs:7
-

References Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Setup.SetupApplication.Configuration, Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Host.Core.Application.ConfigureAuthenticationPipeline(), Tgstation.Server.Host.Core.Application.ConfigureServices(), Tgstation.Server.Host.Setup.IPostSetupServices.DatabaseConfiguration, Tgstation.Server.Host.Configuration.DatabaseConfiguration.DatabaseType, Tgstation.Server.Host.Controllers.ApiController.DefaultPageSize, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Disable, Tgstation.Server.Host.Setup.IPostSetupServices.ElasticsearchConfiguration, Tgstation.Server.Host.Setup.IPostSetupServices.FileLoggingConfiguration, Tgstation.Server.Host.Setup.IPostSetupServices.GeneralConfiguration, Tgstation.Server.Host.IO.IIOManager.GetDirectoryName(), Tgstation.Server.Host.IO.IIOManager.GetFileNameWithoutExtension(), Tgstation.Server.Host.Configuration.FileLoggingConfiguration.GetFullLogDirectory(), Tgstation.Server.Host.Configuration.GeneralConfiguration.HostApiDocumentation, Tgstation.Server.Host.Core.Application.hostingEnvironment, Tgstation.Server.Host.Setup.IPostSetupServices.InternalConfiguration, Tgstation.Server.Host.System.IPlatformIdentifier.IsWindows, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.LogLevel, Tgstation.Server.Host.Controllers.ApiController.MaximumPageSize, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.MicrosoftLogLevel, Tgstation.Server.Host.Setup.IPostSetupServices.PlatformIdentifier, Tgstation.Server.Host.Security.TgsAuthorizeAttribute.PolicyName, Tgstation.Server.Host.Configuration.GeneralConfiguration.RestartTimeoutMinutes, Tgstation.Server.Host.Utils.SerilogContextHelper.Template, Tgstation.Server.Host.Security.TgsAuthorizeAttribute.UserEnabledRole, and Tgstation.Server.Host.Configuration.InternalConfiguration.UsingSystemD.

+

References Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Setup.SetupApplication.Configuration, Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure(), Tgstation.Server.Host.Core.Application.ConfigureAuthenticationPipeline(), Tgstation.Server.Host.Core.Application.ConfigureServices(), Tgstation.Server.Host.Setup.IPostSetupServices.DatabaseConfiguration, Tgstation.Server.Host.Configuration.DatabaseConfiguration.DatabaseType, Tgstation.Server.Host.Controllers.ApiController.DefaultPageSize, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Disable, Tgstation.Server.Host.Setup.IPostSetupServices.ElasticsearchConfiguration, Tgstation.Server.Host.Setup.IPostSetupServices.FileLoggingConfiguration, Tgstation.Server.Host.Setup.IPostSetupServices.GeneralConfiguration, Tgstation.Server.Host.IO.IIOManager.GetDirectoryName(), Tgstation.Server.Host.IO.IIOManager.GetFileNameWithoutExtension(), Tgstation.Server.Host.Configuration.FileLoggingConfiguration.GetFullLogDirectory(), Tgstation.Server.Host.Configuration.GeneralConfiguration.HostApiDocumentation, Tgstation.Server.Host.Core.Application.hostingEnvironment, Tgstation.Server.Host.Setup.IPostSetupServices.InternalConfiguration, Tgstation.Server.Host.System.IPlatformIdentifier.IsWindows, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.LogLevel, Tgstation.Server.Host.Controllers.ApiController.MaximumPageSize, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.MicrosoftLogLevel, Tgstation.Server.Host.Setup.IPostSetupServices.PlatformIdentifier, Tgstation.Server.Host.Security.TgsAuthorizeAttribute.PolicyName, Tgstation.Server.Host.Configuration.GeneralConfiguration.RestartTimeoutMinutes, Tgstation.Server.Host.Utils.SerilogContextHelper.Template, Tgstation.Server.Host.Security.TgsAuthorizeAttribute.UserEnabledRole, and Tgstation.Server.Host.Configuration.InternalConfiguration.UsingSystemD.

Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_seeder.html b/class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_seeder.html index 5c13b592f9..3d0c7e65f0 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_seeder.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_seeder.html @@ -831,7 +831,7 @@ Here is the caller graph for this function:
268
269 await databaseContext.Save(cancellationToken);
270 }
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Api.Rights.RightsHelper
Helper for RightsTypes.
Definition RightsHelper.cs:12
Tgstation.Server.Host.Configuration.GeneralConfiguration.ByondTopicTimeout
uint ByondTopicTimeout
The timeout in milliseconds for sending and receiving topics to/from DreamDaemon. Note that a single ...
Definition GeneralConfiguration.cs:108
Tgstation.Server.Host.Database.DatabaseSeeder.SeedSystemUser
static User SeedSystemUser(IDatabaseContext databaseContext, User? tgsUser=null)
Add a default system User to a given databaseContext .
Definition DatabaseSeeder.cs:63
@@ -840,7 +840,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.System.IPlatformIdentifier.NormalizePath
string NormalizePath(string path)
Normalize a path for consistency.
Tgstation.Server.Host.Authority.PermissionSetLookupType.Id
@ Id
Lookup the Api.Models.EntityId.Id of the Models.PermissionSet.
-

References Tgstation.Server.Host.Configuration.GeneralConfiguration.ByondTopicTimeout, Tgstation.Server.Host.Models.User.CanonicalizeName(), Tgstation.Server.Host.Database.DatabaseSeeder.generalConfiguration, Tgstation.Server.Host.Database.DatabaseSeeder.GetAdminUser(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Database.IDatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Database.DatabaseSeeder.logger, Tgstation.Server.Host.System.IPlatformIdentifier.NormalizePath(), Tgstation.Server.Host.Database.DatabaseSeeder.platformIdentifier, Tgstation.Server.Host.Database.DatabaseSeeder.SeedSystemUser(), Tgstation.Server.Host.Database.DatabaseSeeder.swarmConfiguration, Tgstation.Server.Host.Models.User.TgsSystemUserName, and Tgstation.Server.Host.Database.IDatabaseContext.Users.

+

References Tgstation.Server.Host.Configuration.GeneralConfiguration.ByondTopicTimeout, Tgstation.Server.Host.Models.User.CanonicalizeName(), Tgstation.Server.Host.Database.DatabaseSeeder.generalConfiguration, Tgstation.Server.Host.Database.DatabaseSeeder.GetAdminUser(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Database.IDatabaseContext.Instances, Tgstation.Server.Api.Rights.List, Tgstation.Server.Host.Database.DatabaseSeeder.logger, Tgstation.Server.Host.System.IPlatformIdentifier.NormalizePath(), Tgstation.Server.Host.Database.DatabaseSeeder.platformIdentifier, Tgstation.Server.Host.Database.DatabaseSeeder.SeedSystemUser(), Tgstation.Server.Host.Database.DatabaseSeeder.swarmConfiguration, Tgstation.Server.Host.Models.User.TgsSystemUserName, and Tgstation.Server.Host.Database.IDatabaseContext.Users.

Referenced by Tgstation.Server.Host.Database.DatabaseSeeder.Initialize().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_database_1_1_my_sql_database_context.html b/class_tgstation_1_1_server_1_1_host_1_1_database_1_1_my_sql_database_context.html index 6439c93a7f..582b442e74 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_database_1_1_my_sql_database_context.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_database_1_1_my_sql_database_context.html @@ -521,8 +521,8 @@ Properties
104 .MapMySqlTextField<User>(x => x.SystemIdentifier)
105 .MapMySqlTextField<UserGroup>(x => x.Name);
106 }
-
string? ConnectionString
The information used to connect to the Provider.
-
virtual ? string Name
The name of the entity represented by the NamedEntity.
+
string? ConnectionString
The information used to connect to the Provider.
+
virtual ? string Name
The name of the entity represented by the NamedEntity.
Definition ChatBot.cs:12
Definition CompileJob.cs:11
@@ -536,7 +536,7 @@ Properties
Represents a group of Users.
Definition UserGroup.cs:16
Definition User.cs:17
-

References Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString, and Tgstation.Server.Api.Models.NamedEntity.Name.

+

References Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString, and Tgstation.Server.Api.Models.NamedEntity.Name.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_application_builder_extensions.html b/class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_application_builder_extensions.html index 473dfda510..29087bf3b2 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_application_builder_extensions.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_extensions_1_1_application_builder_extensions.html @@ -226,11 +226,11 @@ Here is the caller graph for this function:
199 await next();
200 });
201 }
-
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:26
+
Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier
string? Identifier
The server's identifier.
Definition SwarmServer.cs:27
Tgstation.Server.Host.Utils.SerilogContextHelper
Helpers for manipulating the Serilog.Context.LogContext.
Definition SerilogContextHelper.cs:7
Tgstation.Server.Host.Utils.SerilogContextHelper.SwarmIdentifierContextProperty
const string SwarmIdentifierContextProperty
The Serilog.Context.LogContext property name for Api.Models.Internal.SwarmServer.Identifiers.
Definition SerilogContextHelper.cs:51
-

References Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, and Tgstation.Server.Host.Utils.SerilogContextHelper.SwarmIdentifierContextProperty.

+

References Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, and Tgstation.Server.Host.Utils.SerilogContextHelper.SwarmIdentifierContextProperty.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_error_message_exception.html b/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_error_message_exception.html index 7a7b8fd7c4..943428cfaf 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_error_message_exception.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_error_message_exception.html @@ -169,11 +169,11 @@ Properties
33 ErrorCode = errorMessage.ErrorCode != default ? errorMessage.ErrorCode : null;
34 AdditionalData = errorMessage.AdditionalData;
35 }
-
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.AdditionalData
string? AdditionalData
Additional data associated with the error message.
Definition ErrorMessageResponse.cs:27
+
Tgstation.Server.Api.Models.Response.ErrorMessageResponse.AdditionalData
string? AdditionalData
Additional data associated with the error message.
Definition ErrorMessageResponse.cs:30
Tgstation.Server.Host.GraphQL.ErrorMessageException.AdditionalData
string? AdditionalData
The ErrorMessageResponse.AdditionalData.
Definition ErrorMessageException.cs:23
Tgstation.Server.Api.Models.ErrorCode
ErrorCode
Types of Response.ErrorMessageResponses that the API may return.
Definition ErrorCode.cs:12
-

References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.AdditionalData, and Tgstation.Server.Host.GraphQL.ErrorMessageException.AdditionalData.

+

References Tgstation.Server.Api.Models.Response.ErrorMessageResponse.AdditionalData, and Tgstation.Server.Host.GraphQL.ErrorMessageException.AdditionalData.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_user_mutations.html b/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_user_mutations.html index 535b711c45..f62149a069 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_user_mutations.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_mutations_1_1_user_mutations.html @@ -837,7 +837,7 @@ Private Attributes
Tgstation.Server.Host.GraphQL.Interfaces.IUserName.Id
long Id
The ID of the user.
Definition IUserName.cs:14
Tgstation.Server.Host.Security.IAuthenticationContext.User
User User
The authenticated user.
Definition IAuthenticationContext.cs:31
-

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Authority.Id, Tgstation.Server.Api.Rights.List, and Tgstation.Server.Host.GraphQL.Mutations.UserMutations.User.

+

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Authority.Id, Tgstation.Server.Api.Rights.List, and Tgstation.Server.Host.GraphQL.Mutations.UserMutations.User.

@@ -905,7 +905,7 @@ Private Attributes
345 cancellationToken));
346 }
-

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Authority.Id, Tgstation.Server.Api.Rights.List, and Tgstation.Server.Host.GraphQL.Mutations.UserMutations.User.

+

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Authority.Id, Tgstation.Server.Api.Rights.List, and Tgstation.Server.Host.GraphQL.Mutations.UserMutations.User.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_types_1_1_swarm_node.html b/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_types_1_1_swarm_node.html index 1ecfc8c897..55f8585af1 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_types_1_1_swarm_node.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_graph_q_l_1_1_types_1_1_swarm_node.html @@ -182,7 +182,7 @@ Properties
Tgstation.Server.Host.GraphQL.Types.SwarmNode.Address
Uri Address
The swarm server's internal Uri.
Definition SwarmNode.cs:38
Tgstation.Server.Host.GraphQL.Types.SwarmNode.PublicAddress
Uri? PublicAddress
The swarm server's optional public address.
Definition SwarmNode.cs:43
-

References Tgstation.Server.Api.Models.Internal.SwarmServer.Address, Tgstation.Server.Host.GraphQL.Types.SwarmNode.Address, Tgstation.Server.Api.Models.Internal.SwarmServerInformation.Controller, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.GraphQL.Types.SwarmNode.Identifier, Tgstation.Server.Api.Models.Internal.SwarmServer.PublicAddress, and Tgstation.Server.Host.GraphQL.Types.SwarmNode.PublicAddress.

+

References Tgstation.Server.Api.Models.Internal.SwarmServer.Address, Tgstation.Server.Host.GraphQL.Types.SwarmNode.Address, Tgstation.Server.Api.Models.Internal.SwarmServerInformation.Controller, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.GraphQL.Types.SwarmNode.Identifier, Tgstation.Server.Api.Models.Internal.SwarmServer.PublicAddress, and Tgstation.Server.Host.GraphQL.Types.SwarmNode.PublicAddress.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_service.html b/class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_service.html index 7fe501fa16..f5809fbe3a 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_service.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_job_service.html @@ -184,7 +184,7 @@ Public Member Functions
  void SetJobProgress (JobResponse apiResponse) - Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .
Parameters
+ Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .
Parameters
apiResponseThe JobResponse to update.
@@ -485,13 +485,13 @@ Static Private Attributes
288
289 return job;
290 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
ValueTask UseContext(Func< IDatabaseContext, ValueTask > operation)
Run an operation in the scope of an IDatabaseContext.
@ Id
Lookup the Api.Models.EntityId.Id of the Models.PermissionSet.
-

References Tgstation.Server.Host.Jobs.JobService.addCancelLock, Tgstation.Server.Host.Jobs.JobHandler.Cancel(), Tgstation.Server.Host.Jobs.JobService.databaseContextFactory, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Jobs.JobService.jobs, Tgstation.Server.Host.Jobs.JobService.logger, Tgstation.Server.Host.Jobs.JobService.synchronizationLock, Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext(), and Tgstation.Server.Host.Jobs.JobHandler.Wait().

+

References Tgstation.Server.Host.Jobs.JobService.addCancelLock, Tgstation.Server.Host.Jobs.JobHandler.Cancel(), Tgstation.Server.Host.Jobs.JobService.databaseContextFactory, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Jobs.JobService.jobs, Tgstation.Server.Host.Jobs.JobService.logger, Tgstation.Server.Host.Jobs.JobService.synchronizationLock, Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext(), and Tgstation.Server.Host.Jobs.JobHandler.Wait().

Referenced by Tgstation.Server.Host.Jobs.JobService.StopAsync(), and Tgstation.Server.Host.Jobs.JobService.WaitForJobCompletion().

@@ -697,14 +697,14 @@ Here is the caller graph for this function:
187 throw;
188 }
189 }
-
string? Description
English description of the Job.
Definition Job.cs:24
- +
string? Description
English description of the Job.
Definition Job.cs:25
+
async Task< bool > RunJob(Job job, JobEntrypoint operation, CancellationToken cancellationToken)
Runner for JobHandlers.
volatile bool noMoreJobsShouldStart
Prevents jobs that are registered after shutdown from activating.
Definition JobService.cs:83
User? StartedBy
See JobResponse.StartedBy.
Definition Job.cs:21
Instance? Instance
The Models.Instance the job belongs to if any.
Definition Job.cs:32
-

References Tgstation.Server.Host.Jobs.JobService.addCancelLock, Tgstation.Server.Host.Jobs.JobService.databaseContextFactory, Tgstation.Server.Api.Models.Internal.Job.Description, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Models.Job.Instance, Tgstation.Server.Host.Jobs.JobService.jobs, Tgstation.Server.Host.Jobs.JobService.logger, Tgstation.Server.Api.Models.UserName.Name, Tgstation.Server.Host.Jobs.JobService.noMoreJobsShouldStart, Tgstation.Server.Host.Jobs.JobService.RunJob(), Tgstation.Server.Host.Models.Job.StartedBy, Tgstation.Server.Host.Jobs.JobService.synchronizationLock, and Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext().

+

References Tgstation.Server.Host.Jobs.JobService.addCancelLock, Tgstation.Server.Host.Jobs.JobService.databaseContextFactory, Tgstation.Server.Api.Models.Internal.Job.Description, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Models.Job.Instance, Tgstation.Server.Host.Jobs.JobService.jobs, Tgstation.Server.Host.Jobs.JobService.logger, Tgstation.Server.Api.Models.UserName.Name, Tgstation.Server.Host.Jobs.JobService.noMoreJobsShouldStart, Tgstation.Server.Host.Jobs.JobService.RunJob(), Tgstation.Server.Host.Models.Job.StartedBy, Tgstation.Server.Host.Jobs.JobService.synchronizationLock, and Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext().

Here is the call graph for this function:
@@ -975,16 +975,16 @@ Here is the call graph for this function:
556 }
557 }
-
ErrorCode? ErrorCode
The Models.ErrorCode associated with the Job if any.
Definition Job.cs:30
-
bool? Cancelled
If the Job was cancelled.
Definition Job.cs:54
-
string? ExceptionDetails
Details of any exceptions caught during the Job.
Definition Job.cs:36
+
ErrorCode? ErrorCode
The Models.ErrorCode associated with the Job if any.
Definition Job.cs:31
+
bool? Cancelled
If the Job was cancelled.
Definition Job.cs:56
+
string? ExceptionDetails
Details of any exceptions caught during the Job.
Definition Job.cs:37
Represents a long running job on the server. Model is read-only, updates attempt to cancel the job.
Definition JobResponse.cs:7
const int MaxHubUpdatesPerSecond
The maximum rate at which hub clients can receive updates.
Definition JobService.cs:33
Helpers for manipulating the Serilog.Context.LogContext.
const string JobIdContextProperty
The Serilog.Context.LogContext property name for Models.Job Api.Models.EntityId.Ids.
-

References Tgstation.Server.Host.Jobs.JobService.activationTcs, Tgstation.Server.Api.Models.Internal.Job.Cancelled, Tgstation.Server.Host.Jobs.JobService.databaseContextFactory, Tgstation.Server.Api.Models.Internal.Job.ErrorCode, Tgstation.Server.Host.Jobs.JobException.ErrorCode, Tgstation.Server.Api.Models.Internal.Job.ExceptionDetails, Tgstation.Server.Host.Jobs.JobService.hub, Tgstation.Server.Host.Jobs.JobsHub.HubGroupName(), Tgstation.Server.Host.Jobs.JobService.hubUpdateActions, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Models.Job.Instance, Tgstation.Server.Host.Utils.SerilogContextHelper.JobIdContextProperty, Tgstation.Server.Host.Jobs.JobService.jobs, Tgstation.Server.Host.Jobs.JobService.logger, Tgstation.Server.Host.Jobs.JobService.loggerFactory, Tgstation.Server.Host.Jobs.JobService.MaxHubUpdatesPerSecond, Tgstation.Server.Host.Jobs.JobService.synchronizationLock, Tgstation.Server.Host.Models.Job.ToApi(), and Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext().

+

References Tgstation.Server.Host.Jobs.JobService.activationTcs, Tgstation.Server.Api.Models.Internal.Job.Cancelled, Tgstation.Server.Host.Jobs.JobService.databaseContextFactory, Tgstation.Server.Api.Models.Internal.Job.ErrorCode, Tgstation.Server.Host.Jobs.JobException.ErrorCode, Tgstation.Server.Api.Models.Internal.Job.ExceptionDetails, Tgstation.Server.Host.Jobs.JobService.hub, Tgstation.Server.Host.Jobs.JobsHub.HubGroupName(), Tgstation.Server.Host.Jobs.JobService.hubUpdateActions, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Host.Models.Job.Instance, Tgstation.Server.Host.Utils.SerilogContextHelper.JobIdContextProperty, Tgstation.Server.Host.Jobs.JobService.jobs, Tgstation.Server.Host.Jobs.JobService.logger, Tgstation.Server.Host.Jobs.JobService.loggerFactory, Tgstation.Server.Host.Jobs.JobService.MaxHubUpdatesPerSecond, Tgstation.Server.Host.Jobs.JobService.synchronizationLock, Tgstation.Server.Host.Models.Job.ToApi(), and Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext().

Referenced by Tgstation.Server.Host.Jobs.JobService.RegisterOperation().

@@ -1032,7 +1032,7 @@ Here is the caller graph for this function:
-

Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .

Parameters
+

Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .

Parameters
apiResponseThe JobResponse to update.
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_jobs_hub_group_mapper.html b/class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_jobs_hub_group_mapper.html index ecb04bfb86..d68d784ec7 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_jobs_hub_group_mapper.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_jobs_hub_group_mapper.html @@ -678,9 +678,9 @@ Here is the caller graph for this function:
86 hub.AbortUnauthedConnections(user);
87 return ValueTask.CompletedTask;
88 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
-

References Tgstation.Server.Host.Jobs.JobsHubGroupMapper.hub, Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Host.Jobs.JobsHubGroupMapper.logger.

+

References Tgstation.Server.Host.Jobs.JobsHubGroupMapper.hub, Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Host.Jobs.JobsHubGroupMapper.logger.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_chat_bot.html b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_chat_bot.html index 32b3a5a577..afacff87a8 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_chat_bot.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_chat_bot.html @@ -264,7 +264,7 @@ Properties

-

References Tgstation.Server.Api.Models.Internal.ChatBotSettings.ChannelLimit, Tgstation.Server.Host.Models.ChatBot.Channels, Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString, Tgstation.Server.Api.Models.Internal.ChatBotSettings.Enabled, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Models.NamedEntity.Name, Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider, and Tgstation.Server.Api.Models.Internal.ChatBotSettings.ReconnectionInterval.

+

References Tgstation.Server.Api.Models.Internal.ChatBotSettings.ChannelLimit, Tgstation.Server.Host.Models.ChatBot.Channels, Tgstation.Server.Api.Models.Internal.ChatBotSettings.ConnectionString, Tgstation.Server.Api.Models.Internal.ChatBotSettings.Enabled, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Models.NamedEntity.Name, Tgstation.Server.Api.Models.Internal.ChatBotSettings.Provider, and Tgstation.Server.Api.Models.Internal.ChatBotSettings.ReconnectionInterval.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_chat_channel.html b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_chat_channel.html index 8b29064bea..b7a4e0f204 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_chat_channel.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_chat_channel.html @@ -174,7 +174,7 @@ Properties
Returns
The converted Api.Models.ChatChannel.
-

References Tgstation.Server.Host.Models.ChatChannel.DiscordChannelId, Tgstation.Server.Host.Models.ChatChannel.IrcChannel, Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsAdminChannel, Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsSystemChannel, Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsUpdatesChannel, Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsWatchdogChannel, and Tgstation.Server.Api.Models.Internal.ChatChannelBase.Tag.

+

References Tgstation.Server.Host.Models.ChatChannel.DiscordChannelId, Tgstation.Server.Host.Models.ChatChannel.IrcChannel, Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsAdminChannel, Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsSystemChannel, Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsUpdatesChannel, Tgstation.Server.Api.Models.Internal.ChatChannelBase.IsWatchdogChannel, and Tgstation.Server.Api.Models.Internal.ChatChannelBase.Tag.

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_compile_job.html b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_compile_job.html index febaa9a7ad..4d2ba5f1e1 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_compile_job.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_compile_job.html @@ -361,7 +361,7 @@ Private Member Functions

-

References Tgstation.Server.Api.Models.Internal.CompileJob.DirectoryName, Tgstation.Server.Host.Models.CompileJob.DMApiVersion, Tgstation.Server.Api.Models.Internal.CompileJob.DmeName, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Models.Internal.CompileJob.MinimumSecurityLevel, Tgstation.Server.Api.Models.Internal.CompileJob.Output, Tgstation.Server.Host.Models.CompileJob.RepositoryOrigin, Tgstation.Server.Host.Models.Job.ToApi(), and Tgstation.Server.Host.Models.RevisionInformation.ToApi().

+

References Tgstation.Server.Api.Models.Internal.CompileJob.DirectoryName, Tgstation.Server.Host.Models.CompileJob.DMApiVersion, Tgstation.Server.Api.Models.Internal.CompileJob.DmeName, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Models.Internal.CompileJob.MinimumSecurityLevel, Tgstation.Server.Api.Models.Internal.CompileJob.Output, Tgstation.Server.Host.Models.CompileJob.RepositoryOrigin, Tgstation.Server.Host.Models.Job.ToApi(), and Tgstation.Server.Host.Models.RevisionInformation.ToApi().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html index 60623a17eb..a5cb2070a5 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html @@ -244,10 +244,10 @@ Private Member Functions
80 {
81 Id = id;
82 }
-
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:13
+
virtual ? long Id
The ID of the entity.
Definition EntityId.cs:14
@ List
User may list files if the Models.Instance allows it.
-

References Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Rights.List.

+

References Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Api.Rights.List.

@@ -334,13 +334,13 @@ Private Member Functions
109 }
Metadata about a server instance.
Definition Instance.cs:9
-
string? Description
English description of the Job.
Definition Job.cs:24
-
RightsType? CancelRightsType
The RightsType of CancelRight if it can be cancelled.
Definition Job.cs:60
-
ulong? CancelRight
The Rights required to cancel the Job.
Definition Job.cs:66
+
string? Description
English description of the Job.
Definition Job.cs:25
+
RightsType? CancelRightsType
The RightsType of CancelRight if it can be cancelled.
Definition Job.cs:62
+
ulong? CancelRight
The Rights required to cancel the Job.
Definition Job.cs:68
User? StartedBy
See JobResponse.StartedBy.
Definition Job.cs:21
JobCode
The different types of Response.JobResponse.
Definition JobCode.cs:9
-

References Tgstation.Server.Api.Models.Internal.Job.CancelRight, Tgstation.Server.Api.Models.Internal.Job.CancelRightsType, Tgstation.Server.Api.Models.Internal.Job.Description, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, and Tgstation.Server.Host.Models.Job.StartedBy.

+

References Tgstation.Server.Api.Models.Internal.Job.CancelRight, Tgstation.Server.Api.Models.Internal.Job.CancelRightsType, Tgstation.Server.Api.Models.Internal.Job.Description, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, and Tgstation.Server.Host.Models.Job.StartedBy.

@@ -537,7 +537,7 @@ Here is the caller graph for this function:

-

References Tgstation.Server.Api.Models.Internal.Job.Cancelled, Tgstation.Server.Host.Models.Job.CancelledBy, Tgstation.Server.Api.Models.Internal.Job.CancelRight, Tgstation.Server.Api.Models.Internal.Job.CancelRightsType, Tgstation.Server.Api.Models.UserName.CreateUserName(), Tgstation.Server.Api.Models.Internal.Job.Description, Tgstation.Server.Api.Models.Internal.Job.ErrorCode, Tgstation.Server.Api.Models.Internal.Job.ExceptionDetails, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Api.Models.Internal.Job.StartedAt, Tgstation.Server.Host.Models.Job.StartedBy, and Tgstation.Server.Api.Models.Internal.Job.StoppedAt.

+

References Tgstation.Server.Api.Models.Internal.Job.Cancelled, Tgstation.Server.Host.Models.Job.CancelledBy, Tgstation.Server.Api.Models.Internal.Job.CancelRight, Tgstation.Server.Api.Models.Internal.Job.CancelRightsType, Tgstation.Server.Api.Models.UserName.CreateUserName(), Tgstation.Server.Api.Models.Internal.Job.Description, Tgstation.Server.Api.Models.Internal.Job.ErrorCode, Tgstation.Server.Api.Models.Internal.Job.ExceptionDetails, Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Rights.List, Tgstation.Server.Api.Models.Internal.Job.StartedAt, Tgstation.Server.Host.Models.Job.StartedBy, and Tgstation.Server.Api.Models.Internal.Job.StoppedAt.

Referenced by Tgstation.Server.Host.Controllers.RepositoryController.Create(), Tgstation.Server.Host.Controllers.RepositoryController.Delete(), Tgstation.Server.Host.Controllers.RepositoryController.Reclone(), Tgstation.Server.Host.Jobs.JobService.RunJob(), and Tgstation.Server.Host.Models.CompileJob.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_test_merge.html b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_test_merge.html index 81fecb9b3d..b93f124321 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_test_merge.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_test_merge.html @@ -202,7 +202,7 @@ Additional Inherited Members

-

References Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Author, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.BodyAtMerge, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Api.Models.Internal.TestMergeApiBase.Id, Tgstation.Server.Api.Models.Internal.TestMergeApiBase.MergedAt, Tgstation.Server.Host.Models.TestMerge.MergedBy, Tgstation.Server.Api.Models.TestMergeParameters.Number, Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TitleAtMerge, and Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Url.

+

References Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Author, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.BodyAtMerge, Tgstation.Server.Api.Models.TestMergeParameters.Comment, Tgstation.Server.Api.Models.Internal.TestMergeApiBase.Id, Tgstation.Server.Api.Models.Internal.TestMergeApiBase.MergedAt, Tgstation.Server.Host.Models.TestMerge.MergedBy, Tgstation.Server.Api.Models.TestMergeParameters.Number, Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha, Tgstation.Server.Api.Models.Internal.TestMergeModelBase.TitleAtMerge, and Tgstation.Server.Api.Models.Internal.TestMergeModelBase.Url.

Referenced by Tgstation.Server.Host.Models.RevisionInformation.ToApi().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user_group.html b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user_group.html index e00e898b0c..06e7157da1 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user_group.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user_group.html @@ -213,7 +213,7 @@ Here is the caller graph for this function:
Returns
A new UserGroupResponse.
-

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Models.NamedEntity.Name, Tgstation.Server.Host.Models.UserGroup.ToApi(), and Tgstation.Server.Host.Models.UserGroup.Users.

+

References Tgstation.Server.Api.Models.EntityId.Id, Tgstation.Server.Api.Models.NamedEntity.Name, Tgstation.Server.Host.Models.UserGroup.ToApi(), and Tgstation.Server.Host.Models.UserGroup.Users.

Referenced by Tgstation.Server.Host.Models.User.CreateUserResponse().

diff --git a/class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context_factory.html b/class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context_factory.html index 66cbc439f3..8184b73800 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context_factory.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_security_1_1_authentication_context_factory.html @@ -466,7 +466,7 @@ Private Attributes
204 }
long? InstanceId
The instance EntityId.Id being accessed.
Definition ApiHeaders.cs:84
-
string? Identifier
The server's identifier.
+
string? Identifier
The server's identifier.
int initialized
1 if currentAuthenticationContext was initialized, 0 otherwise.
@@ -474,7 +474,7 @@ Private Attributes
IDatabaseCollection< User > Users
The Users in the IDatabaseContext.
ISystemIdentity LoadCachedIdentity(User user)
Attempt to load a cached ISystemIdentity.
-

References Tgstation.Server.Host.Security.AuthenticationContextFactory.apiHeaders, Tgstation.Server.Host.Security.AuthenticationContextFactory.currentAuthenticationContext, Tgstation.Server.Host.Security.AuthenticationContextFactory.databaseContext, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Security.AuthenticationContextFactory.identityCache, Tgstation.Server.Host.Security.AuthenticationContext.Initialize(), Tgstation.Server.Host.Security.AuthenticationContextFactory.initialized, Tgstation.Server.Api.ApiHeaders.InstanceId, Tgstation.Server.Host.Security.IIdentityCache.LoadCachedIdentity(), Tgstation.Server.Host.Security.AuthenticationContextFactory.logger, Tgstation.Server.Host.Security.AuthenticationContextFactory.swarmConfiguration, and Tgstation.Server.Host.Database.IDatabaseContext.Users.

+

References Tgstation.Server.Host.Security.AuthenticationContextFactory.apiHeaders, Tgstation.Server.Host.Security.AuthenticationContextFactory.currentAuthenticationContext, Tgstation.Server.Host.Security.AuthenticationContextFactory.databaseContext, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Security.AuthenticationContextFactory.identityCache, Tgstation.Server.Host.Security.AuthenticationContext.Initialize(), Tgstation.Server.Host.Security.AuthenticationContextFactory.initialized, Tgstation.Server.Api.ApiHeaders.InstanceId, Tgstation.Server.Host.Security.IIdentityCache.LoadCachedIdentity(), Tgstation.Server.Host.Security.AuthenticationContextFactory.logger, Tgstation.Server.Host.Security.AuthenticationContextFactory.swarmConfiguration, and Tgstation.Server.Host.Database.IDatabaseContext.Users.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_swarm_service.html b/class_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_swarm_service.html index 0603c2dcc2..7af39754a8 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_swarm_service.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_swarm_1_1_swarm_service.html @@ -552,7 +552,7 @@ Private Attributes
224 swarmController = true;
225 }
-
string? Identifier
The server's identifier.
+
string? Identifier
The server's identifier.
override? Uri Address
override? Uri PublicAddress
volatile? TaskCompletionSource forceHealthCheckTcs
A TaskCompletionSource that is used to force a health check.
@@ -572,7 +572,7 @@ Private Attributes
readonly IServerUpdater serverUpdater
The IServerUpdater for the SwarmService.
readonly IDatabaseSeeder databaseSeeder
The IDatabaseSeeder for the SwarmService.
-

References Tgstation.Server.Host.Configuration.SwarmConfiguration.Address, Tgstation.Server.Host.Swarm.SwarmService.assemblyInformationProvider, Tgstation.Server.Host.Swarm.SwarmService.asyncDelayer, Tgstation.Server.Host.Swarm.SwarmService.databaseContextFactory, Tgstation.Server.Host.Swarm.SwarmService.databaseSeeder, Tgstation.Server.Host.Swarm.SwarmService.forceHealthCheckTcs, Tgstation.Server.Host.Swarm.SwarmService.httpClientFactory, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Configuration.SwarmConfiguration.PublicAddress, Tgstation.Server.Host.Swarm.SwarmService.registrationIdsAndTimes, Tgstation.Server.Host.Swarm.SwarmService.serverHealthCheckCancellationTokenSource, Tgstation.Server.Host.Swarm.SwarmService.serverUpdater, Tgstation.Server.Host.Swarm.SwarmService.swarmConfiguration, Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Swarm.SwarmService.swarmServers, Tgstation.Server.Host.Swarm.SwarmService.tokenFactory, and Tgstation.Server.Host.Swarm.SwarmService.transferService.

+

References Tgstation.Server.Host.Configuration.SwarmConfiguration.Address, Tgstation.Server.Host.Swarm.SwarmService.assemblyInformationProvider, Tgstation.Server.Host.Swarm.SwarmService.asyncDelayer, Tgstation.Server.Host.Swarm.SwarmService.databaseContextFactory, Tgstation.Server.Host.Swarm.SwarmService.databaseSeeder, Tgstation.Server.Host.Swarm.SwarmService.forceHealthCheckTcs, Tgstation.Server.Host.Swarm.SwarmService.httpClientFactory, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Configuration.SwarmConfiguration.PublicAddress, Tgstation.Server.Host.Swarm.SwarmService.registrationIdsAndTimes, Tgstation.Server.Host.Swarm.SwarmService.serverHealthCheckCancellationTokenSource, Tgstation.Server.Host.Swarm.SwarmService.serverUpdater, Tgstation.Server.Host.Swarm.SwarmService.swarmConfiguration, Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Swarm.SwarmService.swarmServers, Tgstation.Server.Host.Swarm.SwarmService.tokenFactory, and Tgstation.Server.Host.Swarm.SwarmService.transferService.

@@ -812,7 +812,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Utils.IAsyncDelayer.Delay
ValueTask Delay(TimeSpan timeSpan, CancellationToken cancellationToken)
Create a Task that completes after a given timeSpan .
Tgstation.Server.Host.Swarm.SwarmCommitResult
SwarmCommitResult
How to proceed on the commit step of an update.
Definition SwarmCommitResult.cs:7
-

References Tgstation.Server.Host.Swarm.SwarmService.AbortUpdate(), Tgstation.Server.Host.Swarm.SwarmService.asyncDelayer, Tgstation.Server.Common.Http.IAbstractHttpClientFactory.CreateClient(), Tgstation.Server.Host.Utils.IAsyncDelayer.Delay(), Tgstation.Server.Host.Swarm.SwarmService.httpClientFactory, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Swarm.SwarmService.swarmServers, Tgstation.Server.Host.Swarm.SwarmConstants.UpdateCommitTimeoutMinutes, Tgstation.Server.Host.Swarm.SwarmService.updateOperation, Tgstation.Server.Host.Swarm.SwarmConstants.UpdateRoute, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

+

References Tgstation.Server.Host.Swarm.SwarmService.AbortUpdate(), Tgstation.Server.Host.Swarm.SwarmService.asyncDelayer, Tgstation.Server.Common.Http.IAbstractHttpClientFactory.CreateClient(), Tgstation.Server.Host.Utils.IAsyncDelayer.Delay(), Tgstation.Server.Host.Swarm.SwarmService.httpClientFactory, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Swarm.SwarmService.swarmServers, Tgstation.Server.Host.Swarm.SwarmConstants.UpdateCommitTimeoutMinutes, Tgstation.Server.Host.Swarm.SwarmService.updateOperation, Tgstation.Server.Host.Swarm.SwarmConstants.UpdateRoute, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

Here is the call graph for this function:
@@ -1659,7 +1659,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Swarm.SwarmService.MarkServersDirty
void MarkServersDirty()
Set serversDirty and complete the current forceHealthCheckTcs.
Definition SwarmService.cs:1199
Tgstation.Server.Host.Swarm.SwarmService.serversDirty
bool serversDirty
If the swarmServers list has been updated and needs to be resent to clients.
Definition SwarmService.cs:159
-

References Tgstation.Server.Host.Swarm.SwarmConstants.ControllerHealthCheckIntervalMinutes, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

+

References Tgstation.Server.Host.Swarm.SwarmConstants.ControllerHealthCheckIntervalMinutes, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

Here is the call graph for this function:
@@ -1736,7 +1736,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext
ValueTask UseContext(Func< IDatabaseContext, ValueTask > operation)
Run an operation in the scope of an IDatabaseContext.
Tgstation.Server.Host.Database.IDatabaseSeeder.Initialize
ValueTask Initialize(IDatabaseContext databaseContext, CancellationToken cancellationToken)
Setup up a given databaseContext .
-

References Tgstation.Server.Host.Swarm.SwarmService.databaseContextFactory, Tgstation.Server.Host.Swarm.SwarmService.databaseSeeder, Tgstation.Server.Host.Swarm.SwarmService.HealthCheckLoop(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Database.IDatabaseSeeder.Initialize(), Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Swarm.SwarmService.RegisterWithController(), Tgstation.Server.Host.Swarm.SwarmService.serverHealthCheckCancellationTokenSource, Tgstation.Server.Host.Swarm.SwarmService.serverHealthCheckTask, Tgstation.Server.Host.Swarm.SwarmService.swarmConfiguration, Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Configuration.SwarmConfiguration.UpdateRequiredNodeCount, and Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext().

+

References Tgstation.Server.Host.Swarm.SwarmService.databaseContextFactory, Tgstation.Server.Host.Swarm.SwarmService.databaseSeeder, Tgstation.Server.Host.Swarm.SwarmService.HealthCheckLoop(), Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Database.IDatabaseSeeder.Initialize(), Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Swarm.SwarmService.RegisterWithController(), Tgstation.Server.Host.Swarm.SwarmService.serverHealthCheckCancellationTokenSource, Tgstation.Server.Host.Swarm.SwarmService.serverHealthCheckTask, Tgstation.Server.Host.Swarm.SwarmService.swarmConfiguration, Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Configuration.SwarmConfiguration.UpdateRequiredNodeCount, and Tgstation.Server.Host.Database.IDatabaseContextFactory.UseContext().

Here is the call graph for this function:
@@ -1990,7 +1990,7 @@ Here is the caller graph for this function:
Tgstation.Server.Host.Configuration.SwarmConfiguration.ControllerAddress
Uri? ControllerAddress
The SwarmServer.Address of the swarm controller. If null, the current server is considered the contro...
Definition SwarmConfiguration.cs:39
Tgstation.Server.Host.Core.Application
Sets up dependency injection.
Definition Application.cs:83
-

References Tgstation.Server.Api.Models.Internal.SwarmServer.Address, Tgstation.Server.Host.Swarm.SwarmConstants.ApiKeyHeader, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmConstants.RegistrationIdHeader, and Tgstation.Server.Host.Swarm.SwarmConstants.SerializerSettings.

+

References Tgstation.Server.Api.Models.Internal.SwarmServer.Address, Tgstation.Server.Host.Swarm.SwarmConstants.ApiKeyHeader, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmConstants.RegistrationIdHeader, and Tgstation.Server.Host.Swarm.SwarmConstants.SerializerSettings.

Referenced by Tgstation.Server.Host.Swarm.SwarmService.CommitUpdate(), Tgstation.Server.Host.Swarm.SwarmService.ControllerDistributedPrepareUpdate(), Tgstation.Server.Host.Swarm.SwarmService.CreateUpdateStreamProvider(), Tgstation.Server.Host.Swarm.SwarmService.PrepareUpdateImpl(), Tgstation.Server.Host.Swarm.SwarmService.RemoteAbortUpdate(), and Tgstation.Server.Host.Swarm.SwarmService.Shutdown().

@@ -2448,7 +2448,7 @@ Here is the call graph for this function:
Tgstation.Server.Host.Core.IServerUpdater.BeginUpdate
ValueTask< ServerUpdateResult > BeginUpdate(ISwarmService swarmService, IFileStreamProvider? fileStreamProvider, Version version, CancellationToken cancellationToken)
Start the process of downloading and applying an update to a new server version .
Tgstation.Server.Host.Core.ServerUpdateResult
ServerUpdateResult
The result of a call to start a server update.
Definition ServerUpdateResult.cs:7
-

References Tgstation.Server.Host.Swarm.SwarmService.AbortUpdate(), Tgstation.Server.Host.Core.IServerUpdater.BeginUpdate(), Tgstation.Server.Host.Swarm.SwarmService.ControllerDistributedPrepareUpdate(), Tgstation.Server.Common.Http.IAbstractHttpClientFactory.CreateClient(), Tgstation.Server.Host.Swarm.SwarmService.CreateDownloadTickets(), Tgstation.Server.Host.Swarm.SwarmService.CreateUpdateStreamProvider(), Tgstation.Server.Host.Swarm.SwarmUpdateRequest.DownloadTickets, Tgstation.Server.Host.Swarm.SwarmService.httpClientFactory, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.serverUpdater, Tgstation.Server.Host.Swarm.SwarmUpdateRequest.SourceNode, Tgstation.Server.Host.Swarm.SwarmService.swarmConfiguration, Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Swarm.SwarmService.swarmServers, Tgstation.Server.Host.Swarm.SwarmService.updateOperation, Tgstation.Server.Host.Swarm.SwarmConstants.UpdateRoute, and Tgstation.Server.Host.Swarm.SwarmUpdateRequest.UpdateVersion.

+

References Tgstation.Server.Host.Swarm.SwarmService.AbortUpdate(), Tgstation.Server.Host.Core.IServerUpdater.BeginUpdate(), Tgstation.Server.Host.Swarm.SwarmService.ControllerDistributedPrepareUpdate(), Tgstation.Server.Common.Http.IAbstractHttpClientFactory.CreateClient(), Tgstation.Server.Host.Swarm.SwarmService.CreateDownloadTickets(), Tgstation.Server.Host.Swarm.SwarmService.CreateUpdateStreamProvider(), Tgstation.Server.Host.Swarm.SwarmUpdateRequest.DownloadTickets, Tgstation.Server.Host.Swarm.SwarmService.httpClientFactory, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Swarm.SwarmService.PrepareSwarmRequest(), Tgstation.Server.Host.Swarm.SwarmService.serverUpdater, Tgstation.Server.Host.Swarm.SwarmUpdateRequest.SourceNode, Tgstation.Server.Host.Swarm.SwarmService.swarmConfiguration, Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Swarm.SwarmService.swarmServers, Tgstation.Server.Host.Swarm.SwarmService.updateOperation, Tgstation.Server.Host.Swarm.SwarmConstants.UpdateRoute, and Tgstation.Server.Host.Swarm.SwarmUpdateRequest.UpdateVersion.

Referenced by Tgstation.Server.Host.Swarm.SwarmService.PrepareUpdate(), and Tgstation.Server.Host.Swarm.SwarmService.PrepareUpdateFromController().

@@ -2618,7 +2618,7 @@ Here is the caller graph for this function:
Tgstation.Server.Api.Models.Internal.SwarmServer.Address
virtual ? Uri Address
The public address of the server.
Definition SwarmServer.cs:15
Tgstation.Server.Host.Security.ITokenFactory.SigningKeyBytes
ReadOnlySpan< byte > SigningKeyBytes
Gets or sets the ITokenFactory's signing key bytes.
Definition ITokenFactory.cs:17
-

References Tgstation.Server.Host.Swarm.SwarmService.AbortUpdate(), Tgstation.Server.Api.Models.Internal.SwarmServer.Address, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Swarm.SwarmService.MarkServersDirty(), Tgstation.Server.Api.Models.Internal.SwarmServer.PublicAddress, Tgstation.Server.Host.Swarm.SwarmService.registrationIdsAndTimes, Tgstation.Server.Host.Security.ITokenFactory.SigningKeyBytes, Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Swarm.SwarmService.swarmServers, and Tgstation.Server.Host.Swarm.SwarmService.tokenFactory.

+

References Tgstation.Server.Host.Swarm.SwarmService.AbortUpdate(), Tgstation.Server.Api.Models.Internal.SwarmServer.Address, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Swarm.SwarmService.logger, Tgstation.Server.Host.Swarm.SwarmService.MarkServersDirty(), Tgstation.Server.Api.Models.Internal.SwarmServer.PublicAddress, Tgstation.Server.Host.Swarm.SwarmService.registrationIdsAndTimes, Tgstation.Server.Host.Security.ITokenFactory.SigningKeyBytes, Tgstation.Server.Host.Swarm.SwarmService.swarmController, Tgstation.Server.Host.Swarm.SwarmService.SwarmMode, Tgstation.Server.Host.Swarm.SwarmService.swarmServers, and Tgstation.Server.Host.Swarm.SwarmService.tokenFactory.

Here is the call graph for this function:
@@ -3097,7 +3097,7 @@ Here is the call graph for this function:
1419 .ToList());
1420 }
-

References Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

+

References Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, and Tgstation.Server.Common.Extensions.ValueTaskExtensions.WhenAll().

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html b/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html index 7f40d5f2fe..02810bc901 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html @@ -233,7 +233,7 @@ Private Attributes

References Tgstation.Server.Host.Utils.OpenApiEnumVarNamesExtension.enumType.

-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply().

Here is the caller graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_port_allocator.html b/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_port_allocator.html index 45d6ff30a3..1327e64dc5 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_port_allocator.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_port_allocator.html @@ -429,14 +429,14 @@ Private Attributes
191 }
192 }
-
string? Identifier
The server's identifier.
+
string? Identifier
The server's identifier.
Extension methods for the Socket class.
static void BindTest(IPlatformIdentifier platformIdentifier, ushort port, bool includeIPv6, bool udp)
Attempt to exclusively bind to a given port .
ushort HttpApiPort
The port the server listens on.
IDatabaseCollection< DreamDaemonSettings > DreamDaemonSettings
The Models.DreamDaemonSettings in the IDatabaseContext.
IDatabaseCollection< DreamMakerSettings > DreamMakerSettings
The Models.DreamMakerSettings in the IDatabaseContext.
-

References Tgstation.Server.Host.Extensions.SocketExtensions.BindTest(), Tgstation.Server.Host.Database.IDatabaseContext.DreamDaemonSettings, Tgstation.Server.Host.Database.IDatabaseContext.DreamMakerSettings, Tgstation.Server.Host.Core.IServerPortProvider.HttpApiPort, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Utils.PortAllocator.logger, Tgstation.Server.Host.Utils.PortAllocator.platformIdentifier, Tgstation.Server.Host.Utils.PortAllocator.serverPortProvider, and Tgstation.Server.Host.Utils.PortAllocator.swarmConfiguration.

+

References Tgstation.Server.Host.Extensions.SocketExtensions.BindTest(), Tgstation.Server.Host.Database.IDatabaseContext.DreamDaemonSettings, Tgstation.Server.Host.Database.IDatabaseContext.DreamMakerSettings, Tgstation.Server.Host.Core.IServerPortProvider.HttpApiPort, Tgstation.Server.Api.Models.Internal.SwarmServer.Identifier, Tgstation.Server.Host.Utils.PortAllocator.logger, Tgstation.Server.Host.Utils.PortAllocator.platformIdentifier, Tgstation.Server.Host.Utils.PortAllocator.serverPortProvider, and Tgstation.Server.Host.Utils.PortAllocator.swarmConfiguration.

Here is the call graph for this function:
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html b/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html index 600138a33b..d97f0a386f 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html @@ -175,7 +175,7 @@ Static Private Attributes

Detailed Description

Implements various filters for Swashbuckle.

-

Definition at line 28 of file SwaggerConfiguration.cs.

+

Definition at line 29 of file SwaggerConfiguration.cs.

Member Function Documentation

◆ AddDefaultResponses()

@@ -209,90 +209,90 @@ Static Private Attributes -

Definition at line 127 of file SwaggerConfiguration.cs.

-
128 {
-
129 var errorMessageContent = new Dictionary<string, OpenApiMediaType>
-
130 {
-
131 {
-
132 MediaTypeNames.Application.Json,
-
133 new OpenApiMediaType
-
134 {
-
135 Schema = new OpenApiSchema
-
136 {
-
137 Reference = new OpenApiReference
-
138 {
-
139 Id = nameof(ErrorMessageResponse),
-
140 Type = ReferenceType.Schema,
-
141 },
-
142 },
-
143 }
-
144 },
-
145 };
-
146
-
147 void AddDefaultResponse(HttpStatusCode code, OpenApiResponse concrete)
-
148 {
-
149 string responseKey = $"{(int)code}";
+

Definition at line 131 of file SwaggerConfiguration.cs.

+
132 {
+
133 var errorMessageContent = new Dictionary<string, OpenApiMediaType>
+
134 {
+
135 {
+
136 MediaTypeNames.Application.Json,
+
137 new OpenApiMediaType
+
138 {
+
139 Schema = new OpenApiSchema
+
140 {
+
141 Reference = new OpenApiReference
+
142 {
+
143 Id = nameof(ErrorMessageResponse),
+
144 Type = ReferenceType.Schema,
+
145 },
+
146 },
+
147 }
+
148 },
+
149 };
150
-
151 document.Components.Responses.Add(responseKey, concrete);
-
152
-
153 var referenceResponse = new OpenApiResponse
-
154 {
-
155 Reference = new OpenApiReference
-
156 {
-
157 Type = ReferenceType.Response,
-
158 Id = responseKey,
-
159 },
-
160 };
-
161
-
162 foreach (var operation in document.Paths.SelectMany(path => path.Value.Operations))
-
163 operation.Value.Responses.TryAdd(responseKey, referenceResponse);
-
164 }
+
151 void AddDefaultResponse(HttpStatusCode code, OpenApiResponse concrete)
+
152 {
+
153 string responseKey = $"{(int)code}";
+
154
+
155 document.Components.Responses.Add(responseKey, concrete);
+
156
+
157 var referenceResponse = new OpenApiResponse
+
158 {
+
159 Reference = new OpenApiReference
+
160 {
+
161 Type = ReferenceType.Response,
+
162 Id = responseKey,
+
163 },
+
164 };
165
-
166 AddDefaultResponse(HttpStatusCode.BadRequest, new OpenApiResponse
-
167 {
-
168 Description = "A badly formatted request was made. See error message for details.",
-
169 Content = errorMessageContent,
-
170 });
-
171
-
172 AddDefaultResponse(HttpStatusCode.Unauthorized, new OpenApiResponse
-
173 {
-
174 Description = "Invalid Authentication header.",
-
175 });
-
176
-
177 AddDefaultResponse(HttpStatusCode.Forbidden, new OpenApiResponse
-
178 {
-
179 Description = "User lacks sufficient permissions for the operation.",
-
180 });
-
181
-
182 AddDefaultResponse(HttpStatusCode.Conflict, new OpenApiResponse
-
183 {
-
184 Description = "A data integrity check failed while performing the operation. See error message for details.",
-
185 Content = errorMessageContent,
-
186 });
-
187
-
188 AddDefaultResponse(HttpStatusCode.NotAcceptable, new OpenApiResponse
-
189 {
-
190 Description = $"Invalid Accept header, TGS requires `{HeaderNames.Accept}: {MediaTypeNames.Application.Json}`.",
-
191 Content = errorMessageContent,
-
192 });
-
193
-
194 AddDefaultResponse(HttpStatusCode.InternalServerError, new OpenApiResponse
-
195 {
-
196 Description = ErrorCode.InternalServerError.Describe(),
-
197 Content = errorMessageContent,
-
198 });
-
199
-
200 AddDefaultResponse(HttpStatusCode.ServiceUnavailable, new OpenApiResponse
-
201 {
-
202 Description = "The server may be starting up or shutting down.",
-
203 });
-
204
-
205 AddDefaultResponse(HttpStatusCode.NotImplemented, new OpenApiResponse
-
206 {
-
207 Description = ErrorCode.RequiresPosixSystemIdentity.Describe(),
-
208 Content = errorMessageContent,
-
209 });
-
210 }
+
166 foreach (var operation in document.Paths.SelectMany(path => path.Value.Operations))
+
167 operation.Value.Responses.TryAdd(responseKey, referenceResponse);
+
168 }
+
169
+
170 AddDefaultResponse(HttpStatusCode.BadRequest, new OpenApiResponse
+
171 {
+
172 Description = "A badly formatted request was made. See error message for details.",
+
173 Content = errorMessageContent,
+
174 });
+
175
+
176 AddDefaultResponse(HttpStatusCode.Unauthorized, new OpenApiResponse
+
177 {
+
178 Description = "Invalid Authentication header.",
+
179 });
+
180
+
181 AddDefaultResponse(HttpStatusCode.Forbidden, new OpenApiResponse
+
182 {
+
183 Description = "User lacks sufficient permissions for the operation.",
+
184 });
+
185
+
186 AddDefaultResponse(HttpStatusCode.Conflict, new OpenApiResponse
+
187 {
+
188 Description = "A data integrity check failed while performing the operation. See error message for details.",
+
189 Content = errorMessageContent,
+
190 });
+
191
+
192 AddDefaultResponse(HttpStatusCode.NotAcceptable, new OpenApiResponse
+
193 {
+
194 Description = $"Invalid Accept header, TGS requires `{HeaderNames.Accept}: {MediaTypeNames.Application.Json}`.",
+
195 Content = errorMessageContent,
+
196 });
+
197
+
198 AddDefaultResponse(HttpStatusCode.InternalServerError, new OpenApiResponse
+
199 {
+
200 Description = ErrorCode.InternalServerError.Describe(),
+
201 Content = errorMessageContent,
+
202 });
+
203
+
204 AddDefaultResponse(HttpStatusCode.ServiceUnavailable, new OpenApiResponse
+
205 {
+
206 Description = "The server may be starting up or shutting down.",
+
207 });
+
208
+
209 AddDefaultResponse(HttpStatusCode.NotImplemented, new OpenApiResponse
+
210 {
+
211 Description = ErrorCode.RequiresPosixSystemIdentity.Describe(),
+
212 Content = errorMessageContent,
+
213 });
+
214 }
Represents an error message returned by the server.
@ Id
Lookup the Api.Models.EntityId.Id of the Models.PermissionSet.
@@ -326,34 +326,33 @@ Static Private Attributes

-

Definition at line 469 of file SwaggerConfiguration.cs.

-
470 {
-
471 ArgumentNullException.ThrowIfNull(swaggerDoc);
-
472 ArgumentNullException.ThrowIfNull(context);
-
473
-
474 swaggerDoc.ExternalDocs = new OpenApiExternalDocs
-
475 {
-
476 Description = "API Usage Documentation",
-
477 Url = new Uri("https://tgstation.github.io/tgstation-server/api.html"),
-
478 };
-
479
-
480 swaggerDoc.Components.Parameters.Add(ApiHeaders.InstanceIdHeader, new OpenApiParameter
-
481 {
-
482 In = ParameterLocation.Header,
-
483 Name = ApiHeaders.InstanceIdHeader,
-
484 Description = "The instance ID being accessed",
-
485 Required = true,
-
486 Style = ParameterStyle.Simple,
-
487 Schema = new OpenApiSchema
-
488 {
-
489 Type = "integer",
-
490 },
-
491 });
-
492
-
493 var productHeaderSchema = new OpenApiSchema
-
494 {
-
495 Type = "string",
-
496 Format = "productheader",
+

Definition at line 470 of file SwaggerConfiguration.cs.

+
471 {
+
472 ArgumentNullException.ThrowIfNull(swaggerDoc);
+
473 ArgumentNullException.ThrowIfNull(context);
+
474
+
475 swaggerDoc.ExternalDocs = new OpenApiExternalDocs
+
476 {
+
477 Description = "API Usage Documentation",
+
478 Url = new Uri("https://tgstation.github.io/tgstation-server/api.html"),
+
479 };
+
480
+
481 swaggerDoc.Components.Parameters.Add(ApiHeaders.InstanceIdHeader, new OpenApiParameter
+
482 {
+
483 In = ParameterLocation.Header,
+
484 Name = ApiHeaders.InstanceIdHeader,
+
485 Description = "The instance ID being accessed",
+
486 Required = true,
+
487 Style = ParameterStyle.Simple,
+
488 Schema = new OpenApiSchema
+
489 {
+
490 Type = "integer",
+
491 },
+
492 });
+
493
+
494 var productHeaderSchema = new OpenApiSchema
+
495 {
+
496 Type = "string",
497 };
498
499 swaggerDoc.Components.Parameters.Add(ApiHeaders.ApiVersionHeader, new OpenApiParameter
@@ -401,14 +400,36 @@ Static Private Attributes
541 Id = HeaderNames.UserAgent,
542 },
543 });
-
544 }
-
545
-
546 AddDefaultResponses(swaggerDoc);
-
547 }
+
544
+
545 // flatten (Tgstation.Server.*).MyClass
+
546 if (operation.Description?.Length > 0)
+
547 operation.Description = Regex.Replace(operation.Description, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
+
548
+
549 if (operation.Summary?.Length > 0)
+
550 operation.Summary = Regex.Replace(operation.Summary, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
+
551
+
552 if (operation.RequestBody?.Description != null)
+
553 operation.RequestBody.Description = Regex.Replace(operation.RequestBody.Description, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
+
554
+
555 foreach (var opPar in operation.Parameters)
+
556 {
+
557 if (opPar.Description != null)
+
558 opPar.Description = Regex.Replace(opPar.Description, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
+
559 }
+
560
+
561 foreach (var (_, opRes) in operation.Responses)
+
562 {
+
563 if (opRes.Description != null)
+
564 opRes.Description = Regex.Replace(opRes.Description, @"Tgstation\.Server\.(\w+\.)+(?=\w+)", string.Empty);
+
565 }
+
566 }
+
567
+
568 AddDefaultResponses(swaggerDoc);
+
569 }
Represents the header that must be present for every server request.
Definition ApiHeaders.cs:25
const string InstanceIdHeader
The InstanceId header key.
Definition ApiHeaders.cs:34
const string ApiVersionHeader
The ApiVersion header key.
Definition ApiHeaders.cs:29
-
static void AddDefaultResponses(OpenApiDocument document)
Add the default error responses to a given document .
+
static void AddDefaultResponses(OpenApiDocument document)
Add the default error responses to a given document .

References Tgstation.Server.Api.ApiHeaders.InstanceIdHeader.

@@ -442,130 +463,127 @@ Static Private Attributes

-

Definition at line 343 of file SwaggerConfiguration.cs.

-
344 {
-
345 ArgumentNullException.ThrowIfNull(operation);
-
346 ArgumentNullException.ThrowIfNull(context);
-
347
-
348 operation.OperationId = $"{context.MethodInfo.DeclaringType!.Name}.{context.MethodInfo.Name}";
-
349
-
350 var authAttributes = context
-
351 .MethodInfo
-
352 .DeclaringType
-
353 .GetCustomAttributes(true)
-
354 .Union(
-
355 context
-
356 .MethodInfo
-
357 .GetCustomAttributes(true))
-
358 .OfType<TgsAuthorizeAttribute>();
-
359
-
360 if (authAttributes.Any())
-
361 {
-
362 var tokenScheme = new OpenApiSecurityScheme
-
363 {
-
364 Reference = new OpenApiReference
-
365 {
-
366 Type = ReferenceType.SecurityScheme,
- -
368 },
-
369 };
-
370
-
371 operation.Security = new List<OpenApiSecurityRequirement>
-
372 {
-
373 new()
-
374 {
-
375 {
-
376 tokenScheme,
-
377 new List<string>()
-
378 },
-
379 },
-
380 };
-
381
-
382 if (typeof(InstanceRequiredController).IsAssignableFrom(context.MethodInfo.DeclaringType))
-
383 operation.Parameters.Insert(0, new OpenApiParameter
-
384 {
-
385 Reference = new OpenApiReference
-
386 {
-
387 Type = ReferenceType.Parameter,
- -
389 },
-
390 });
-
391 else if (typeof(TransferController).IsAssignableFrom(context.MethodInfo.DeclaringType))
-
392 if (context.MethodInfo.Name == nameof(TransferController.Upload))
-
393 operation.RequestBody = new OpenApiRequestBody
-
394 {
-
395 Content = new Dictionary<string, OpenApiMediaType>
-
396 {
-
397 {
-
398 MediaTypeNames.Application.Octet,
-
399 new OpenApiMediaType
-
400 {
-
401 Schema = new OpenApiSchema
-
402 {
-
403 Type = "string",
-
404 Format = "binary",
-
405 },
-
406 }
-
407 },
-
408 },
-
409 };
-
410 else if (context.MethodInfo.Name == nameof(TransferController.Download))
-
411 {
-
412 var twoHundredResponseContents = operation.Responses["200"].Content;
-
413 var fileContent = twoHundredResponseContents[MediaTypeNames.Application.Json];
-
414 twoHundredResponseContents.Remove(MediaTypeNames.Application.Json);
-
415 twoHundredResponseContents.Add(MediaTypeNames.Application.Octet, fileContent);
-
416 }
-
417 }
-
418 else if (context.MethodInfo.Name == nameof(ApiRootController.CreateToken))
-
419 {
-
420 var passwordScheme = new OpenApiSecurityScheme
-
421 {
-
422 Reference = new OpenApiReference
-
423 {
-
424 Type = ReferenceType.SecurityScheme,
- -
426 },
-
427 };
-
428
-
429 var oAuthScheme = new OpenApiSecurityScheme
-
430 {
-
431 Reference = new OpenApiReference
-
432 {
-
433 Type = ReferenceType.SecurityScheme,
- -
435 },
-
436 };
-
437
-
438 operation.Parameters.Add(new OpenApiParameter
-
439 {
-
440 In = ParameterLocation.Header,
- -
442 Description = "The external OAuth service provider.",
-
443 Style = ParameterStyle.Simple,
-
444 Example = new OpenApiString("Discord"),
-
445 Schema = new OpenApiSchema
-
446 {
-
447 Type = "string",
-
448 },
-
449 });
-
450
-
451 operation.Security = new List<OpenApiSecurityRequirement>
-
452 {
-
453 new()
-
454 {
-
455 {
-
456 passwordScheme,
-
457 new List<string>()
-
458 },
-
459 {
-
460 oAuthScheme,
-
461 new List<string>()
-
462 },
-
463 },
-
464 };
-
465 }
-
466 }
+

Definition at line 347 of file SwaggerConfiguration.cs.

+
348 {
+
349 ArgumentNullException.ThrowIfNull(operation);
+
350 ArgumentNullException.ThrowIfNull(context);
+
351
+
352 operation.OperationId = $"{context.MethodInfo.DeclaringType!.Name}.{context.MethodInfo.Name}";
+
353
+
354 var authAttributes = context
+
355 .MethodInfo
+
356 .DeclaringType
+
357 .GetCustomAttributes(true)
+
358 .Union(
+
359 context
+
360 .MethodInfo
+
361 .GetCustomAttributes(true))
+
362 .OfType<TgsAuthorizeAttribute>();
+
363
+
364 if (authAttributes.Any())
+
365 {
+
366 var tokenScheme = new OpenApiSecurityScheme
+
367 {
+
368 Reference = new OpenApiReference
+
369 {
+
370 Type = ReferenceType.SecurityScheme,
+ +
372 },
+
373 };
+
374
+
375 operation.Security = new List<OpenApiSecurityRequirement>()
+
376 {
+
377 new()
+
378 {
+
379 { tokenScheme, new List<string>() },
+
380 },
+
381 };
+
382
+
383 if (typeof(InstanceRequiredController).IsAssignableFrom(context.MethodInfo.DeclaringType))
+
384 operation.Parameters.Insert(0, new OpenApiParameter
+
385 {
+
386 Reference = new OpenApiReference
+
387 {
+
388 Type = ReferenceType.Parameter,
+ +
390 },
+
391 });
+
392 else if (typeof(TransferController).IsAssignableFrom(context.MethodInfo.DeclaringType))
+
393 if (context.MethodInfo.Name == nameof(TransferController.Upload))
+
394 operation.RequestBody = new OpenApiRequestBody
+
395 {
+
396 Content = new Dictionary<string, OpenApiMediaType>
+
397 {
+
398 {
+
399 MediaTypeNames.Application.Octet,
+
400 new OpenApiMediaType
+
401 {
+
402 Schema = new OpenApiSchema
+
403 {
+
404 Type = "string",
+
405 Format = "binary",
+
406 },
+
407 }
+
408 },
+
409 },
+
410 };
+
411 else if (context.MethodInfo.Name == nameof(TransferController.Download))
+
412 {
+
413 var twoHundredResponseContents = operation.Responses["200"].Content;
+
414 var fileContent = twoHundredResponseContents[MediaTypeNames.Application.Json];
+
415 twoHundredResponseContents.Remove(MediaTypeNames.Application.Json);
+
416 twoHundredResponseContents.Add(MediaTypeNames.Application.Octet, fileContent);
+
417 }
+
418 }
+
419 else if (context.MethodInfo.Name == nameof(ApiRootController.CreateToken))
+
420 {
+
421 var passwordScheme = new OpenApiSecurityScheme
+
422 {
+
423 Reference = new OpenApiReference
+
424 {
+
425 Type = ReferenceType.SecurityScheme,
+ +
427 },
+
428 };
+
429
+
430 var oAuthScheme = new OpenApiSecurityScheme
+
431 {
+
432 Reference = new OpenApiReference
+
433 {
+
434 Type = ReferenceType.SecurityScheme,
+ +
436 },
+
437 };
+
438
+
439 operation.Parameters.Add(new OpenApiParameter
+
440 {
+
441 In = ParameterLocation.Header,
+ +
443 Description = "The external OAuth service provider.",
+
444 Style = ParameterStyle.Simple,
+
445 Example = new OpenApiString("Discord"),
+
446 Schema = new OpenApiSchema
+
447 {
+
448 Type = "string",
+
449 },
+
450 });
+
451
+
452 operation.Security = new List<OpenApiSecurityRequirement>
+
453 {
+
454 new()
+
455 {
+
456 {
+
457 passwordScheme,
+
458 new List<string>()
+
459 },
+
460 {
+
461 oAuthScheme,
+
462 new List<string>()
+
463 },
+
464 },
+
465 };
+
466 }
+
467 }
const string OAuthProviderHeader
The OAuthProvider header key.
Definition ApiHeaders.cs:39
Root ApiController for the Application.
ValueTask< IActionResult > CreateToken(CancellationToken cancellationToken)
Attempt to authenticate a User using ApiController.ApiHeaders.
@@ -574,11 +592,11 @@ Static Private Attributes
ValueTask< IActionResult > Download([Required, FromQuery] string ticket, CancellationToken cancellationToken)
Downloads a file with a given ticket .
async ValueTask< IActionResult > Upload([Required, FromQuery] string ticket, CancellationToken cancellationToken)
Uploads a file with a given ticket .
Helper for using the AuthorizeAttribute with the Api.Rights system.
-
const string OAuthSecuritySchemeId
The OpenApiSecurityScheme name for OAuth 2.0 authentication.
-
const string PasswordSecuritySchemeId
The OpenApiSecurityScheme name for password authentication.
-
const string TokenSecuritySchemeId
The OpenApiSecurityScheme name for token authentication.
+
const string OAuthSecuritySchemeId
The OpenApiSecurityScheme name for OAuth 2.0 authentication.
+
const string PasswordSecuritySchemeId
The OpenApiSecurityScheme name for password authentication.
+
const string TokenSecuritySchemeId
The OpenApiSecurityScheme name for token authentication.
-

References Tgstation.Server.Host.Controllers.ApiRootController.CreateToken(), Tgstation.Server.Host.Controllers.TransferController.Download(), Tgstation.Server.Api.ApiHeaders.InstanceIdHeader, Tgstation.Server.Api.ApiHeaders.OAuthProviderHeader, Tgstation.Server.Host.Utils.SwaggerConfiguration.OAuthSecuritySchemeId, Tgstation.Server.Host.Utils.SwaggerConfiguration.PasswordSecuritySchemeId, Tgstation.Server.Host.Utils.SwaggerConfiguration.TokenSecuritySchemeId, and Tgstation.Server.Host.Controllers.TransferController.Upload().

+

References Tgstation.Server.Host.Controllers.ApiRootController.CreateToken(), Tgstation.Server.Host.Controllers.TransferController.Download(), Tgstation.Server.Api.ApiHeaders.InstanceIdHeader, Tgstation.Server.Api.ApiHeaders.OAuthProviderHeader, Tgstation.Server.Host.Utils.SwaggerConfiguration.OAuthSecuritySchemeId, Tgstation.Server.Host.Utils.SwaggerConfiguration.PasswordSecuritySchemeId, Tgstation.Server.Host.Utils.SwaggerConfiguration.TokenSecuritySchemeId, and Tgstation.Server.Host.Controllers.TransferController.Upload().

Here is the call graph for this function:
@@ -630,13 +648,13 @@ Here is the call graph for this function:

-

Definition at line 573 of file SwaggerConfiguration.cs.

-
574 {
-
575 ArgumentNullException.ThrowIfNull(requestBody);
-
576 ArgumentNullException.ThrowIfNull(context);
-
577
-
578 requestBody.Required = true;
-
579 }
+

Definition at line 595 of file SwaggerConfiguration.cs.

+
596 {
+
597 ArgumentNullException.ThrowIfNull(requestBody);
+
598 ArgumentNullException.ThrowIfNull(context);
+
599
+
600 requestBody.Required = true;
+
601 }
@@ -668,28 +686,28 @@ Here is the call graph for this function:

-

Definition at line 550 of file SwaggerConfiguration.cs.

-
551 {
-
552 ArgumentNullException.ThrowIfNull(schema);
-
553 ArgumentNullException.ThrowIfNull(context);
-
554
-
555 // Nothing is required
-
556 schema.Required.Clear();
-
557
-
558 if (context.MemberInfo == null)
-
559 ApplyAttributesForRootSchema(schema, context);
-
560
-
561 if (!schema.Enum?.Any() ?? false)
-
562 return;
-
563
-
564 // Could be nullable type, make sure to get the right one
-
565 Type firstGenericArgumentOrType = context.Type.IsConstructedGenericType
-
566 ? context.Type.GenericTypeArguments.First()
-
567 : context.Type;
-
568
-
569 OpenApiEnumVarNamesExtension.Apply(schema, firstGenericArgumentOrType);
-
570 }
-
static void ApplyAttributesForRootSchema(OpenApiSchema rootSchema, SchemaFilterContext context)
Applies the OpenApiSchema.Nullable, OpenApiSchema.ReadOnly, and OpenApiSchema.WriteOnly to OpenApiSch...
+

Definition at line 572 of file SwaggerConfiguration.cs.

+
573 {
+
574 ArgumentNullException.ThrowIfNull(schema);
+
575 ArgumentNullException.ThrowIfNull(context);
+
576
+
577 // Nothing is required
+
578 schema.Required.Clear();
+
579
+
580 if (context.MemberInfo == null)
+
581 ApplyAttributesForRootSchema(schema, context);
+
582
+
583 if (!schema.Enum?.Any() ?? false)
+
584 return;
+
585
+
586 // Could be nullable type, make sure to get the right one
+
587 Type firstGenericArgumentOrType = context.Type.IsConstructedGenericType
+
588 ? context.Type.GenericTypeArguments.First()
+
589 : context.Type;
+
590
+
591 OpenApiEnumVarNamesExtension.Apply(schema, firstGenericArgumentOrType);
+
592 }
+
static void ApplyAttributesForRootSchema(OpenApiSchema rootSchema, SchemaFilterContext context)
Applies the OpenApiSchema.Nullable, OpenApiSchema.ReadOnly, and OpenApiSchema.WriteOnly to OpenApiSch...

References Tgstation.Server.Host.Utils.OpenApiEnumVarNamesExtension.Apply().

@@ -748,123 +766,123 @@ Here is the call graph for this function:
-

Definition at line 217 of file SwaggerConfiguration.cs.

-
218 {
-
219 // tune up the descendants
-
220 rootSchema.Nullable = false;
-
221 var rootSchemaId = GenerateSchemaId(context.Type);
-
222 var rootRequestSchema = rootSchemaId.EndsWith("Request", StringComparison.Ordinal);
-
223 var rootResponseSchema = rootSchemaId.EndsWith("Response", StringComparison.Ordinal);
-
224 var isPutRequest = rootSchemaId.EndsWith("CreateRequest", StringComparison.Ordinal);
-
225
-
226 Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>> GetTypeFromKvp(Type currentType, KeyValuePair<string, OpenApiSchema> kvp, IDictionary<string, OpenApiSchema> schemaDictionary)
-
227 {
-
228 var propertyInfo = currentType
-
229 .GetProperties()
-
230 .Single(x => x.Name.Equals(kvp.Key, StringComparison.OrdinalIgnoreCase));
-
231
-
232 return Tuple.Create(
-
233 propertyInfo,
-
234 kvp.Key,
-
235 kvp.Value,
-
236 schemaDictionary);
-
237 }
-
238
-
239 var subSchemaStack = new Stack<Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>>>(
-
240 rootSchema
-
241 .Properties
-
242 .Select(
-
243 x => GetTypeFromKvp(context.Type, x, rootSchema.Properties))
-
244 .Where(x => x.Item3.Reference == null));
-
245
-
246 while (subSchemaStack.Count > 0)
-
247 {
-
248 var tuple = subSchemaStack.Pop();
-
249 var subSchema = tuple.Item3;
-
250
-
251 var subSchemaPropertyInfo = tuple.Item1;
-
252
-
253 if (subSchema.Properties != null
-
254 && !subSchemaPropertyInfo
-
255 .PropertyType
-
256 .GetInterfaces()
-
257 .Any(x => x == typeof(IEnumerable)))
-
258 foreach (var kvp in subSchema.Properties.Where(x => x.Value.Reference == null))
-
259 subSchemaStack.Push(GetTypeFromKvp(subSchemaPropertyInfo.PropertyType, kvp, subSchema.Properties));
-
260
-
261 var attributes = subSchemaPropertyInfo
-
262 .GetCustomAttributes();
-
263 var responsePresence = attributes
-
264 .OfType<ResponseOptionsAttribute>()
-
265 .FirstOrDefault()
-
266 ?.Presence
-
267 ?? FieldPresence.Required;
-
268 var requestOptions = attributes
-
269 .OfType<RequestOptionsAttribute>()
-
270 .OrderBy(x => x.PutOnly) // Process PUTs last
-
271 .ToList();
-
272
-
273 if (requestOptions.Count == 0 && requestOptions.All(x => x.Presence == FieldPresence.Ignored && !x.PutOnly))
-
274 subSchema.ReadOnly = true;
-
275
-
276 var subSchemaId = tuple.Item2;
-
277 var subSchemaOwningDictionary = tuple.Item4;
-
278 if (rootResponseSchema)
-
279 {
-
280 subSchema.Nullable = responsePresence == FieldPresence.Optional;
-
281 if (responsePresence == FieldPresence.Ignored)
-
282 subSchemaOwningDictionary.Remove(subSchemaId);
-
283 }
-
284 else if (rootRequestSchema)
-
285 {
-
286 subSchema.Nullable = true;
-
287 var lastOptionWasIgnored = false;
-
288 foreach (var requestOption in requestOptions)
-
289 {
-
290 var validForThisRequest = !requestOption.PutOnly || isPutRequest;
-
291 if (!validForThisRequest)
-
292 continue;
-
293
-
294 lastOptionWasIgnored = false;
-
295 switch (requestOption.Presence)
-
296 {
-
297 case FieldPresence.Ignored:
-
298 lastOptionWasIgnored = true;
-
299 break;
-
300 case FieldPresence.Optional:
-
301 subSchema.Nullable = true;
-
302 break;
-
303 case FieldPresence.Required:
-
304 subSchema.Nullable = false;
-
305 break;
-
306 default:
-
307 throw new InvalidOperationException($"Invalid FieldPresence: {requestOption.Presence}!");
-
308 }
-
309 }
-
310
-
311 if (lastOptionWasIgnored)
-
312 subSchemaOwningDictionary.Remove(subSchemaId);
-
313 }
-
314 else if (responsePresence == FieldPresence.Required
-
315 && requestOptions.All(x => x.Presence == FieldPresence.Required && !x.PutOnly))
-
316 subSchema.Nullable = subSchemaId.Equals(
- -
318 StringComparison.OrdinalIgnoreCase)
-
319 && rootSchemaId == nameof(TestMergeParameters); // special tactics
-
320
-
321 // otherwise, we have to assume it's a shared schema
-
322 // use what Swagger thinks the nullability is by default
-
323 }
-
324 }
+

Definition at line 221 of file SwaggerConfiguration.cs.

+
222 {
+
223 // tune up the descendants
+
224 rootSchema.Nullable = false;
+
225 var rootSchemaId = GenerateSchemaId(context.Type);
+
226 var rootRequestSchema = rootSchemaId.EndsWith("Request", StringComparison.Ordinal);
+
227 var rootResponseSchema = rootSchemaId.EndsWith("Response", StringComparison.Ordinal);
+
228 var isPutRequest = rootSchemaId.EndsWith("CreateRequest", StringComparison.Ordinal);
+
229
+
230 Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>> GetTypeFromKvp(Type currentType, KeyValuePair<string, OpenApiSchema> kvp, IDictionary<string, OpenApiSchema> schemaDictionary)
+
231 {
+
232 var propertyInfo = currentType
+
233 .GetProperties()
+
234 .Single(x => x.Name.Equals(kvp.Key, StringComparison.OrdinalIgnoreCase));
+
235
+
236 return Tuple.Create(
+
237 propertyInfo,
+
238 kvp.Key,
+
239 kvp.Value,
+
240 schemaDictionary);
+
241 }
+
242
+
243 var subSchemaStack = new Stack<Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>>>(
+
244 rootSchema
+
245 .Properties
+
246 .Select(
+
247 x => GetTypeFromKvp(context.Type, x, rootSchema.Properties))
+
248 .Where(x => x.Item3.Reference == null));
+
249
+
250 while (subSchemaStack.Count > 0)
+
251 {
+
252 var tuple = subSchemaStack.Pop();
+
253 var subSchema = tuple.Item3;
+
254
+
255 var subSchemaPropertyInfo = tuple.Item1;
+
256
+
257 if (subSchema.Properties != null
+
258 && !subSchemaPropertyInfo
+
259 .PropertyType
+
260 .GetInterfaces()
+
261 .Any(x => x == typeof(IEnumerable)))
+
262 foreach (var kvp in subSchema.Properties.Where(x => x.Value.Reference == null))
+
263 subSchemaStack.Push(GetTypeFromKvp(subSchemaPropertyInfo.PropertyType, kvp, subSchema.Properties));
+
264
+
265 var attributes = subSchemaPropertyInfo
+
266 .GetCustomAttributes();
+
267 var responsePresence = attributes
+
268 .OfType<ResponseOptionsAttribute>()
+
269 .FirstOrDefault()
+
270 ?.Presence
+
271 ?? FieldPresence.Required;
+
272 var requestOptions = attributes
+
273 .OfType<RequestOptionsAttribute>()
+
274 .OrderBy(x => x.PutOnly) // Process PUTs last
+
275 .ToList();
+
276
+
277 if (requestOptions.Count == 0 && requestOptions.All(x => x.Presence == FieldPresence.Ignored && !x.PutOnly))
+
278 subSchema.ReadOnly = true;
+
279
+
280 var subSchemaId = tuple.Item2;
+
281 var subSchemaOwningDictionary = tuple.Item4;
+
282 if (rootResponseSchema)
+
283 {
+
284 subSchema.Nullable = responsePresence == FieldPresence.Optional;
+
285 if (responsePresence == FieldPresence.Ignored)
+
286 subSchemaOwningDictionary.Remove(subSchemaId);
+
287 }
+
288 else if (rootRequestSchema)
+
289 {
+
290 subSchema.Nullable = true;
+
291 var lastOptionWasIgnored = false;
+
292 foreach (var requestOption in requestOptions)
+
293 {
+
294 var validForThisRequest = !requestOption.PutOnly || isPutRequest;
+
295 if (!validForThisRequest)
+
296 continue;
+
297
+
298 lastOptionWasIgnored = false;
+
299 switch (requestOption.Presence)
+
300 {
+
301 case FieldPresence.Ignored:
+
302 lastOptionWasIgnored = true;
+
303 break;
+
304 case FieldPresence.Optional:
+
305 subSchema.Nullable = true;
+
306 break;
+
307 case FieldPresence.Required:
+
308 subSchema.Nullable = false;
+
309 break;
+
310 default:
+
311 throw new InvalidOperationException($"Invalid FieldPresence: {requestOption.Presence}!");
+
312 }
+
313 }
+
314
+
315 if (lastOptionWasIgnored)
+
316 subSchemaOwningDictionary.Remove(subSchemaId);
+
317 }
+
318 else if (responsePresence == FieldPresence.Required
+
319 && requestOptions.All(x => x.Presence == FieldPresence.Required && !x.PutOnly))
+
320 subSchema.Nullable = subSchemaId.Equals(
+ +
322 StringComparison.OrdinalIgnoreCase)
+
323 && rootSchemaId == nameof(TestMergeParameters); // special tactics
+
324
+
325 // otherwise, we have to assume it's a shared schema
+
326 // use what Swagger thinks the nullability is by default
+
327 }
+
328 }
Indicates the FieldPresence for fields in models.
Indicates the response FieldPresence of API fields. Changes it from FieldPresence....
-
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
-
static string GenerateSchemaId(Type type)
Generates the OpenAPI schema ID for a given type .
+
virtual ? string TargetCommitSha
The sha of the test merge revision to merge. If not specified, the latest commit from the source will...
+
static string GenerateSchemaId(Type type)
Generates the OpenAPI schema ID for a given type .
FieldPresence
Indicates whether a request field is Required or Ignored.
-

References Tgstation.Server.Host.Utils.SwaggerConfiguration.GenerateSchemaId(), Tgstation.Server.Api.Models.ResponseOptionsAttribute.Presence, and Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha.

+

References Tgstation.Server.Host.Utils.SwaggerConfiguration.GenerateSchemaId(), Tgstation.Server.Api.Models.ResponseOptionsAttribute.Presence, and Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha.

Here is the call graph for this function:
@@ -928,74 +946,77 @@ Here is the call graph for this function:
-

Definition at line 61 of file SwaggerConfiguration.cs.

-
62 {
-
63 swaggerGenOptions.SwaggerDoc(
- -
65 new OpenApiInfo
-
66 {
-
67 Title = "TGS API",
-
68 Version = ApiHeaders.Version.Semver().ToString(),
-
69 License = new OpenApiLicense
-
70 {
-
71 Name = "AGPL-3.0",
-
72 Url = new Uri("https://github.com/tgstation/tgstation-server/blob/dev/LICENSE"),
-
73 },
-
74 Contact = new OpenApiContact
-
75 {
-
76 Name = "/tg/station 13",
-
77 Url = new Uri("https://github.com/tgstation"),
-
78 },
-
79 Description = "A production scale tool for DreamMaker server management",
-
80 });
-
81
-
82 // Important to do this before applying our own filters
-
83 // Otherwise we'll get NullReferenceExceptions on parameters to be setup in our document filter
-
84 swaggerGenOptions.IncludeXmlComments(assemblyDocumentationPath);
-
85 swaggerGenOptions.IncludeXmlComments(apiDocumentationPath);
-
86
-
87 // nullable stuff
-
88 swaggerGenOptions.UseAllOfToExtendReferenceSchemas();
-
89
-
90 swaggerGenOptions.OperationFilter<SwaggerConfiguration>();
-
91 swaggerGenOptions.DocumentFilter<SwaggerConfiguration>();
-
92 swaggerGenOptions.SchemaFilter<SwaggerConfiguration>();
-
93 swaggerGenOptions.RequestBodyFilter<SwaggerConfiguration>();
-
94
-
95 swaggerGenOptions.CustomSchemaIds(GenerateSchemaId);
-
96
-
97 swaggerGenOptions.AddSecurityDefinition(PasswordSecuritySchemeId, new OpenApiSecurityScheme
-
98 {
-
99 In = ParameterLocation.Header,
-
100 Type = SecuritySchemeType.Http,
-
101 Name = HeaderNames.Authorization,
- -
103 });
-
104
-
105 swaggerGenOptions.AddSecurityDefinition(OAuthSecuritySchemeId, new OpenApiSecurityScheme
-
106 {
-
107 In = ParameterLocation.Header,
-
108 Type = SecuritySchemeType.Http,
-
109 Name = HeaderNames.Authorization,
- -
111 });
-
112
-
113 swaggerGenOptions.AddSecurityDefinition(TokenSecuritySchemeId, new OpenApiSecurityScheme
-
114 {
-
115 BearerFormat = "JWT",
-
116 In = ParameterLocation.Header,
-
117 Type = SecuritySchemeType.Http,
-
118 Name = HeaderNames.Authorization,
- -
120 });
-
121 }
+

Definition at line 62 of file SwaggerConfiguration.cs.

+
63 {
+
64 swaggerGenOptions.SwaggerDoc(
+ +
66 new OpenApiInfo
+
67 {
+
68 Title = "TGS API",
+
69 Version = ApiHeaders.Version.Semver().ToString(),
+
70 License = new OpenApiLicense
+
71 {
+
72 Name = "AGPL-3.0",
+
73 Url = new Uri("https://github.com/tgstation/tgstation-server/blob/dev/LICENSE"),
+
74 },
+
75 Contact = new OpenApiContact
+
76 {
+
77 Name = "/tg/station 13",
+
78 Url = new Uri("https://github.com/tgstation"),
+
79 },
+
80 Description = "A production scale tool for DreamMaker server management",
+
81 });
+
82
+
83 // Important to do this before applying our own filters
+
84 // Otherwise we'll get NullReferenceExceptions on parameters to be setup in our document filter
+
85 swaggerGenOptions.IncludeXmlComments(assemblyDocumentationPath);
+
86 swaggerGenOptions.IncludeXmlComments(apiDocumentationPath);
+
87
+
88 // nullable stuff
+
89 swaggerGenOptions.UseAllOfToExtendReferenceSchemas();
+
90
+
91 swaggerGenOptions.OperationFilter<SwaggerConfiguration>();
+
92 swaggerGenOptions.DocumentFilter<SwaggerConfiguration>();
+
93 swaggerGenOptions.SchemaFilter<SwaggerConfiguration>();
+
94 swaggerGenOptions.RequestBodyFilter<SwaggerConfiguration>();
+
95
+
96 swaggerGenOptions.CustomSchemaIds(GenerateSchemaId);
+
97
+
98 swaggerGenOptions.AddSecurityDefinition(PasswordSecuritySchemeId, new OpenApiSecurityScheme
+
99 {
+
100 In = ParameterLocation.Header,
+
101 Type = SecuritySchemeType.Http,
+
102 Name = HeaderNames.Authorization,
+
103 Description = "Username & Password authentication to obtain an JWT token when doing a (POST /api).",
+ +
105 });
+
106
+
107 swaggerGenOptions.AddSecurityDefinition(OAuthSecuritySchemeId, new OpenApiSecurityScheme
+
108 {
+
109 In = ParameterLocation.Header,
+
110 Type = SecuritySchemeType.Http,
+
111 Name = HeaderNames.Authorization,
+
112 Description = "OAuth2 based authentication.",
+ +
114 });
+
115
+
116 swaggerGenOptions.AddSecurityDefinition(TokenSecuritySchemeId, new OpenApiSecurityScheme
+
117 {
+
118 In = ParameterLocation.Header,
+
119 Type = SecuritySchemeType.Http,
+
120 Name = HeaderNames.Authorization,
+
121 Description = "JWT Bearer token generated by the server (POST /api). You need this for most endpoints to work.",
+ +
123 BearerFormat = "JWT",
+
124 });
+
125 }
const string OAuthAuthenticationScheme
The JWT authentication header scheme.
Definition ApiHeaders.cs:54
static readonly Version Version
Get the version of the Api the caller is using.
Definition ApiHeaders.cs:69
const string BasicAuthenticationScheme
The JWT authentication header scheme.
Definition ApiHeaders.cs:49
const string BearerAuthenticationScheme
The JWT authentication header scheme.
Definition ApiHeaders.cs:44
-
const string DocumentName
The name of the swagger document.
+
const string DocumentName
The name of the swagger document.
-

References Tgstation.Server.Api.ApiHeaders.BasicAuthenticationScheme, Tgstation.Server.Api.ApiHeaders.BearerAuthenticationScheme, Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentName, Tgstation.Server.Host.Utils.SwaggerConfiguration.GenerateSchemaId(), Tgstation.Server.Api.ApiHeaders.OAuthAuthenticationScheme, Tgstation.Server.Host.Utils.SwaggerConfiguration.OAuthSecuritySchemeId, Tgstation.Server.Host.Utils.SwaggerConfiguration.PasswordSecuritySchemeId, Tgstation.Server.Host.Utils.SwaggerConfiguration.TokenSecuritySchemeId, and Tgstation.Server.Api.ApiHeaders.Version.

+

References Tgstation.Server.Api.ApiHeaders.BasicAuthenticationScheme, Tgstation.Server.Api.ApiHeaders.BearerAuthenticationScheme, Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentName, Tgstation.Server.Host.Utils.SwaggerConfiguration.GenerateSchemaId(), Tgstation.Server.Api.ApiHeaders.OAuthAuthenticationScheme, Tgstation.Server.Host.Utils.SwaggerConfiguration.OAuthSecuritySchemeId, Tgstation.Server.Host.Utils.SwaggerConfiguration.PasswordSecuritySchemeId, Tgstation.Server.Host.Utils.SwaggerConfiguration.TokenSecuritySchemeId, and Tgstation.Server.Api.ApiHeaders.Version.

Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().

@@ -1055,20 +1076,20 @@ Here is the caller graph for this function:
Returns
The generated schema ID for Type.
-

Definition at line 331 of file SwaggerConfiguration.cs.

-
332 {
-
333 if (type == typeof(UserName))
-
334 return "ShallowUserResponse";
-
335
-
336 if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(PaginatedResponse<>))
-
337 return $"Paginated{type.GenericTypeArguments.First().Name}";
-
338
-
339 return type.Name;
-
340 }
+

Definition at line 335 of file SwaggerConfiguration.cs.

+
336 {
+
337 if (type == typeof(UserName))
+
338 return "ShallowUserResponse";
+
339
+
340 if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(PaginatedResponse<>))
+
341 return $"Paginated{type.GenericTypeArguments.First().Name}";
+
342
+
343 return type.Name;
+
344 }
Base class for user names.
Definition UserName.cs:7
-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.ApplyAttributesForRootSchema(), and Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.ApplyAttributesForRootSchema(), and Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

Here is the caller graph for this function:
@@ -1110,7 +1131,7 @@ Here is the caller graph for this function:

The path to the hosted documentation site.

-

Definition at line 38 of file SwaggerConfiguration.cs.

+

Definition at line 39 of file SwaggerConfiguration.cs.

Referenced by Tgstation.Server.Host.Core.Application.Configure(), and Tgstation.Server.Host.Controllers.RootController.Index().

@@ -1138,9 +1159,9 @@ Here is the caller graph for this function:

The name of the swagger document.

-

Definition at line 33 of file SwaggerConfiguration.cs.

+

Definition at line 34 of file SwaggerConfiguration.cs.

-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

@@ -1166,9 +1187,9 @@ Here is the caller graph for this function:

The OpenApiSecurityScheme name for OAuth 2.0 authentication.

-

Definition at line 48 of file SwaggerConfiguration.cs.

+

Definition at line 49 of file SwaggerConfiguration.cs.

-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

@@ -1194,9 +1215,9 @@ Here is the caller graph for this function:

The OpenApiSecurityScheme name for password authentication.

-

Definition at line 43 of file SwaggerConfiguration.cs.

+

Definition at line 44 of file SwaggerConfiguration.cs.

-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

@@ -1222,9 +1243,9 @@ Here is the caller graph for this function:

The OpenApiSecurityScheme name for token authentication.

-

Definition at line 53 of file SwaggerConfiguration.cs.

+

Definition at line 54 of file SwaggerConfiguration.cs.

-

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

+

Referenced by Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply(), and Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure().

diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html b/interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html index 7917bfd47c..20626099c7 100644 --- a/interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html +++ b/interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html @@ -99,7 +99,7 @@ Inheritance diagram for Tgstation.Server.Host.Jobs.IJobManager:

Public Member Functions

void SetJobProgress (JobResponse apiResponse) - Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .
+ Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .
  ValueTask RegisterOperation (Job job, JobEntrypoint operation, CancellationToken cancellationToken)  Registers a given Job and begins running it.
@@ -295,7 +295,7 @@ Here is the caller graph for this function:
-

Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .

+

Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .

Parameters
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_service.html b/interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_service.html index 4a921779a1..99961cf7ff 100644 --- a/interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_service.html +++ b/interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_service.html @@ -121,7 +121,7 @@ Public Member Functions - +
apiResponseThe JobResponse to update.
 
- Public Member Functions inherited from Tgstation.Server.Host.Jobs.IJobManager
void SetJobProgress (JobResponse apiResponse)
 Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .
 Set the JobResponse.Progress and JobResponse.Stage for a given apiResponse .
 
ValueTask RegisterOperation (Job job, JobEntrypoint operation, CancellationToken cancellationToken)
 Registers a given Job and begins running it.