Routes to a server actions. More...

Collaboration diagram for Tgstation.Server.Api.Routes:

Static Public Member Functions
static string	SetID (string route, long id)
	Apply an id postfix to a route .

static string	ListRoute (string route)
	Get the /List postfix for a route .

static string	SanitizeGetPath (string path)
	Sanitize a Models.Response.FileTicketResponse path for use in a GET Uri.

Static Public Attributes
const string	ApiRoot = "/api/"
	The root of API methods.

const string	GraphQL = ApiRoot + "graphql"
	The GraphQL route.

const string	HubsRoot = ApiRoot + "hubs"
	The root route of all hubs.

const string	Administration = ApiRoot + "Administration"
	The server administration controller.

const string	Logs = Administration + "/Logs"
	The endpoint to download server logs.

const string	User = ApiRoot + "User"
	The user controller.

const string	UserGroup = ApiRoot + "UserGroup"
	The user group controller.

const string	InstanceManager = ApiRoot + "Instance"
	The Models.Instance controller.

const string	Engine = ApiRoot + "Engine"
	The engine controller.

const string	Repository = ApiRoot + "Repository"
	The git repository controller.

const string	DreamDaemon = ApiRoot + "DreamDaemon"
	The DreamDaemon controller.

const string	Diagnostics = DreamDaemon + "/Diagnostics"
	For accessing DD diagnostics.

const string	Configuration = ApiRoot + "Config"
	The configuration controller.

const string	File = "File"
	To be paired with Configuration for accessing Models.IConfigurationFiles.

const string	ConfigurationFile = Configuration + "/" + File
	Full combination of Configuration and File.

const string	InstancePermissionSet = ApiRoot + "InstancePermissionSet"
	The instance permission set controller.

const string	Chat = ApiRoot + "Chat"
	The chat bot controller.

const string	DreamMaker = ApiRoot + "DreamMaker"
	The deployment controller.

const string	Jobs = ApiRoot + "Job"
	The jobs controller.

const string	Transfer = ApiRoot + "Transfer"
	The transfer controller.

const string	List = "List"
	The postfix for list operations.

const string	JobsHub = HubsRoot + "/jobs"
	The root route of all hubs.

Detailed Description

Routes to a server actions.

Definition at line 8 of file Routes.cs.

Member Function Documentation

◆ ListRoute()

static string Tgstation.Server.Api.Routes.ListRoute ( string route )

static

Get the /List postfix for a route .

Parameters

route The route.

Returns: The route with /List appended.

◆ SanitizeGetPath()

static string Tgstation.Server.Api.Routes.SanitizeGetPath ( string path )

static

Sanitize a Models.Response.FileTicketResponse path for use in a GET Uri.

Parameters

path	The path to sanitize.

Returns: The sanitized path.

Definition at line 140 of file Routes.cs.

        {
            path ??= String.Empty;
            if (path.Length == 0 || path[0] != '/')
                path = '/' + path;
            return path;
        }

References Tgstation.Server.Api.Routes.List.

Referenced by Tgstation.Server.Client.AdministrationClient.GetLog(), and Tgstation.Server.Client.Components.ConfigurationClient.Read().

Here is the caller graph for this function:

◆ SetID()

static string Tgstation.Server.Api.Routes.SetID	(	string	route,
		long	id
	)

static

Apply an id postfix to a route .

Parameters

route	The route.
id	The ID.

Returns: The route with id appended.

Member Data Documentation

◆ Administration

const string Tgstation.Server.Api.Routes.Administration = ApiRoot + "Administration"

static

The server administration controller.

Definition at line 28 of file Routes.cs.

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

◆ ApiRoot

const string Tgstation.Server.Api.Routes.ApiRoot = "/api/"

static

The root of API methods.

Definition at line 13 of file Routes.cs.

Referenced by Tgstation.Server.Client.RestServerClientFactory.CreateWithNewToken(), Tgstation.Server.Client.RestServerClientFactory.GetServerInformation(), and Tgstation.Server.Client.ApiClient.RefreshToken().

◆ Chat

const string Tgstation.Server.Api.Routes.Chat = ApiRoot + "Chat"

static

The chat bot controller.

Definition at line 93 of file Routes.cs.

◆ Configuration

const string Tgstation.Server.Api.Routes.Configuration = ApiRoot + "Config"

static

The configuration controller.

Definition at line 73 of file Routes.cs.

Referenced by Tgstation.Server.Client.Components.ConfigurationClient.Write().

◆ ConfigurationFile

const string Tgstation.Server.Api.Routes.ConfigurationFile = Configuration + "/" + File

static

Full combination of Configuration and File.

Definition at line 83 of file Routes.cs.

◆ Diagnostics

const string Tgstation.Server.Api.Routes.Diagnostics = DreamDaemon + "/Diagnostics"

static

For accessing DD diagnostics.

Definition at line 68 of file Routes.cs.

◆ DreamDaemon

const string Tgstation.Server.Api.Routes.DreamDaemon = ApiRoot + "DreamDaemon"

static

The DreamDaemon controller.

Definition at line 63 of file Routes.cs.

◆ DreamMaker

const string Tgstation.Server.Api.Routes.DreamMaker = ApiRoot + "DreamMaker"

static

The deployment controller.

Definition at line 98 of file Routes.cs.

◆ Engine

const string Tgstation.Server.Api.Routes.Engine = ApiRoot + "Engine"

static

The engine controller.

Definition at line 53 of file Routes.cs.

Referenced by Tgstation.Server.Client.Components.EngineClient.SetActiveVersion().

◆ File

const string Tgstation.Server.Api.Routes.File = "File"

static

To be paired with Configuration for accessing Models.IConfigurationFiles.

Definition at line 78 of file Routes.cs.

◆ GraphQL

const string Tgstation.Server.Api.Routes.GraphQL = ApiRoot + "graphql"

static

The GraphQL route.

Definition at line 18 of file Routes.cs.

Referenced by Tgstation.Server.Host.Controllers.RootController.Index(), and Tgstation.Server.Client.GraphQL.GraphQLServerClientFactory.SetupServiceProvider().

◆ HubsRoot

const string Tgstation.Server.Api.Routes.HubsRoot = ApiRoot + "hubs"

static

The root route of all hubs.

Definition at line 23 of file Routes.cs.

◆ InstanceManager

const string Tgstation.Server.Api.Routes.InstanceManager = ApiRoot + "Instance"

static

The Models.Instance controller.

Definition at line 48 of file Routes.cs.

◆ InstancePermissionSet

const string Tgstation.Server.Api.Routes.InstancePermissionSet = ApiRoot + "InstancePermissionSet"

static

The instance permission set controller.

Definition at line 88 of file Routes.cs.

◆ Jobs

const string Tgstation.Server.Api.Routes.Jobs = ApiRoot + "Job"

static

The jobs controller.

Definition at line 103 of file Routes.cs.

◆ JobsHub

const string Tgstation.Server.Api.Routes.JobsHub = HubsRoot + "/jobs"

static

The root route of all hubs.

Definition at line 118 of file Routes.cs.

Referenced by Tgstation.Server.Client.ApiClient.CreateHubConnection< THubImplementation >().

◆ List

const string Tgstation.Server.Api.Routes.List = "List"

static

The postfix for list operations.

Definition at line 113 of file Routes.cs.

Referenced by Tgstation.Server.Api.Routes.SanitizeGetPath().

◆ Logs

const string Tgstation.Server.Api.Routes.Logs = Administration + "/Logs"

static

The endpoint to download server logs.

Definition at line 33 of file Routes.cs.

◆ Repository

const string Tgstation.Server.Api.Routes.Repository = ApiRoot + "Repository"

static

The git repository controller.

Definition at line 58 of file Routes.cs.

◆ Transfer

const string Tgstation.Server.Api.Routes.Transfer = ApiRoot + "Transfer"

static

The transfer controller.

Definition at line 108 of file Routes.cs.

◆ User

const string Tgstation.Server.Api.Routes.User = ApiRoot + "User"

static

The user controller.

Definition at line 38 of file Routes.cs.

◆ UserGroup

const string Tgstation.Server.Api.Routes.UserGroup = ApiRoot + "UserGroup"

static

The user group controller.

Definition at line 43 of file Routes.cs.

The documentation for this class was generated from the following file:

src/Tgstation.Server.Api/Routes.cs

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ ListRoute()

◆ SanitizeGetPath()

◆ SetID()

Member Data Documentation

◆ Administration

◆ ApiRoot

◆ Chat

◆ Configuration

◆ ConfigurationFile

◆ Diagnostics

◆ DreamDaemon

◆ DreamMaker

◆ Engine

◆ File

◆ GraphQL

◆ HubsRoot

◆ InstanceManager

◆ InstancePermissionSet

◆ Jobs

◆ JobsHub

◆ List

◆ Logs

◆ Repository

◆ Transfer

◆ User

◆ UserGroup