Tgstation.Server.Api Namespace Reference

Namespaces
namespace	Extensions
namespace	Hubs
namespace	Models
namespace	Properties
namespace	Rights

Classes
class	ApiHeaders
	Represents the header that must be present for every server request. More...
class	DefaultCredentials
	Represents initial credentials used by the server. More...
class	HeadersException
	Thrown when trying to generate ApiHeaders from Microsoft.AspNetCore.Http.Headers.RequestHeaders fails. More...
class	Routes
	Routes to a server actions. More...

Enumerations
enum	HeaderErrorTypes {   None = 0 , UserAgent = 1 << 0 , Accept = 1 << 1 , Api = 1 << 2 ,   AuthorizationInvalid = 1 << 3 , OAuthProvider = 1 << 4 , AuthorizationMissing = 1 << 5 }
	Types of individual ApiHeaders errors. More...

Enumeration Type Documentation

HeaderErrorTypes

enum Tgstation.Server.Api.HeaderErrorTypes

Types of individual ApiHeaders errors.

Enumerator
None	No header errors.
UserAgent	The Microsoft.Net.Http.Headers.HeaderNames.UserAgent header is missing or invalid.
Accept	The Microsoft.Net.Http.Headers.HeaderNames.Accept header is missing or invalid.
Api	The ApiHeaders.ApiVersionHeader header is missing or invalid.
AuthorizationInvalid	The Microsoft.Net.Http.Headers.HeaderNames.Authorization header is invalid.
OAuthProvider	The ApiHeaders.OAuthProviderHeader header is missing or invalid.
AuthorizationMissing	The Microsoft.Net.Http.Headers.HeaderNames.Authorization header is missing.

Definition at line 9 of file HeaderErrorTypes.cs.

    {
        None = 0,
 
        UserAgent = 1 << 0,
 
        Accept = 1 << 1,
 
        Api = 1 << 2,
 
        AuthorizationInvalid = 1 << 3,
 
        OAuthProvider = 1 << 4,
 
        AuthorizationMissing = 1 << 5,
    }