From d4bbe7533c84dfe61ceea530d2e360f181fc36a5 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Wed, 28 Nov 2018 14:58:59 -0500 Subject: [PATCH] Get tab enforcement going --- build/analyzers.ruleset | 3 +- build/stylecop.json | 8 + .../Tgstation.Server.Api.csproj | 9 +- .../Tgstation.Server.Api.xml | 1720 ++++++++++++++++ .../Tgstation.Server.Client.csproj | 11 +- .../Tgstation.Server.Client.xml | 1733 +++++++++++++++++ .../Tgstation.Server.Host.Console.csproj | 5 +- .../Tgstation.Server.Host.Service.csproj | 7 +- .../Tgstation.Server.Host.Watchdog.csproj | 6 +- .../Tgstation.Server.Host.csproj | 5 +- tgstation-server.sln | 1 + 11 files changed, 3498 insertions(+), 10 deletions(-) create mode 100644 build/stylecop.json create mode 100644 src/Tgstation.Server.Api/Tgstation.Server.Api.xml create mode 100644 src/Tgstation.Server.Client/Tgstation.Server.Client.xml diff --git a/build/analyzers.ruleset b/build/analyzers.ruleset index 88adfbf857..75495a4ace 100644 --- a/build/analyzers.ruleset +++ b/build/analyzers.ruleset @@ -1026,7 +1026,6 @@ - @@ -1040,6 +1039,7 @@ + @@ -1047,6 +1047,7 @@ + diff --git a/build/stylecop.json b/build/stylecop.json new file mode 100644 index 0000000000..e683e4e39b --- /dev/null +++ b/build/stylecop.json @@ -0,0 +1,8 @@ +{ + "settings": { + "indentation": { + "tabSize": 4, + "useTabs": true + } + } +} diff --git a/src/Tgstation.Server.Api/Tgstation.Server.Api.csproj b/src/Tgstation.Server.Api/Tgstation.Server.Api.csproj index d4566a2d4f..527d81c160 100644 --- a/src/Tgstation.Server.Api/Tgstation.Server.Api.csproj +++ b/src/Tgstation.Server.Api/Tgstation.Server.Api.csproj @@ -30,7 +30,8 @@ - 1701;1702;SA1652;CA1028 + 1701;1702;CA1028 + D:\tgstation-server\src\Tgstation.Server.Api\Tgstation.Server.Api.xml @@ -39,10 +40,14 @@ all compile; build; native; contentfiles; analyzers - + all runtime; build; native; contentfiles; analyzers + + + + diff --git a/src/Tgstation.Server.Api/Tgstation.Server.Api.xml b/src/Tgstation.Server.Api/Tgstation.Server.Api.xml new file mode 100644 index 0000000000..c06438b8de --- /dev/null +++ b/src/Tgstation.Server.Api/Tgstation.Server.Api.xml @@ -0,0 +1,1720 @@ + + + + Tgstation.Server.Api + + + + + Represents the header that must be present for every server request + + + + + TODO: Remove this when https://github.com/dotnet/corefx/pull/26701 makes it into the sdk + + + + + The header key + + + + + The header key + + + + + The header key + + + + + The JWT authentication header scheme + + + + + The password authentication header scheme + + + + + The current + + + + + Get the version of the the caller is using + + + + + The being accessed + + + + + The client's user agent + + + + + The client's API version + + + + + The client's JWT + + + + + The client's username + + + + + The client's password + + + + + If the header uses password or JWT authentication + + + + + Checks if a given is compatible with our own + + The to test + if the given version is compatible with the API. otherwise + + + + Construct for JWT authentication + + The value of + The value of + + + + Construct for password authentication + + The value of + The value of + The value of + + + + Construct and validates from a set of + + The containing the + + + + Construct + + The value of + The value of + The value of + The value of + + + + Checks if the is compatible with + + if the API is compatible, otherwise + + + + Set using the . This initially clears + + The to set + The for the request + + + + Represents administrative server information + + + + + If the server is running on a windows operating system + + + + + The GitHub repository the server is built to recieve updates from + + + + + The latest available version of the Tgstation.Server.Host assembly from the upstream repository. If is higher than 's the update cannot be applied due to API changes + + + + + Changes the version of Tgstation.Server.Host to the given version from the upstream repository + + + + + Represents a BYOND installation + + + + + The of the installation used for new compiles. Will be if the user does not have permission to view it or there is no BYOND version installed. Only considers the and numbers + + + + + The being used to install a new + + + + + + + + Channels the Discord bot should listen/announce in + + + + + Validates are correct for the + + if the are valid for the , otherwise + + + + Indicates a chat channel + + + + + The IRC channel name + + + + + The Discord channel ID + + + + + If the is an admin channel + + + + + If the is a watchdog channel + + + + + If the is an updates channel + + + + + A custom tag users can define to group channels together + + + + + Represents a chat service provider + + + + + Internet relay chat + + + + + Superior chat service + + + + + + + + The relating to this job + + + + + Git revision the compiler ran on. Not modifiable + + + + + The the was made with + + + + + Represents a game configuration file. Create and delete actions uncerimonuously overwrite/delete files + + + + + The path to the file + + + + + If access to the file was denied for the operation + + + + + If represents a directory + + + + + The MD5 hash of the file when last read by the user. If this doesn't match during update actions, the write will be denied with + + + + + The content of the . Will be if is or during listing and write operations + + + + + The type of configuration allowed on an + + + + + Configuration editing is not allowed + + + + + Configuration editing is allowed by all users on all files + + + + + Co + + + + + for + + + + + + + + The Discord bot token + + See https://discordapp.com/developers/docs/topics/oauth2#bots + + + + Construct a + + + + + Construct a from a + + The connection string + + + + + + + Represents an instance of BYOND's DreamDaemon game server. Create action starts the server. Delete action shuts down the server + + + + + The live revision + + + + + The next revision to go live + + + + + The current status of + + + + + The current of . May be downgraded due to requirements of + + + + + The port the running instance is set to + + + + + The webclient status the running instance is set to + + + + + DreamDaemon's security level + + + + + Server is unrestricted in terms of file access and shell commands + + + + + Server will not be able to run shell commands or access files outside it's working directory + + + + + Server will not be able to run shell commands or access anything but temporary files. Currently unsupported! + + + + + The status of + + + + + Server is not running + + + + + Server is being rebooted + + + + + Server is running + + + + + Represents the state of the DreamMaker compiler. Create action starts a new compile. Delete action cancels the current compile + + + + + The .dme file tries to compile with without the extension + + + + + The port used during compilation to validate the DMAPI + + + + + The level used to validate the DMAPI + + + + + Represents an error message returned by the server + + + + + A human readable description of the error + + + + + The version of the API the server is using + + + + + Metadata about a server instance + + + + + The id of the . Not modifiable + + + + + The name of the + + + + + The path to where the is located. Can only be changed while the is offline. Must not exist when the instance is created + + + + + If the is online + + + + + If can be used on the + + + + + The time interval in minutes the repository is automatically pulled and compiles. 0 disables + + + + + The representing a change of + + Due to how s are children of s but moving one requires the to be offline, interactions with this are performed in a non-standard fashion. The is read by querying the again (either via list or ID lookup) and cancelled by making any sort of update to the . Once the comes back it can be queried like a normal job + + + + Create a clone of the essential metadata + + A clone of the essential metadata + + + + Represents a s permissions in an + + + + + The of the the belongs to + + + + + The of the + + + + + The of the + + + + + The of the + + + + + The of the + + + + + The of the + + + + + The of the + + + + + The of the + + + + + Manage the server chat bots + + + + + The settings id + + + + + The name of the connection + + + + + If the connection is enabled + + + + + The used for the connection + + + + + The information used to connect to the + + + + + The which maps to the + + + + + Helper for building s + + + + + If the evaluates to a valid + + + + + Gets the associated with the + + The associated with the + + + + Represents a run of + + + + + The ID of the job + + + + + The .dme file used for compilation + + + + + Textual output of DM + + + + + The Game folder the results were compiled into + + + + + The minimum required to run the 's output + + + + + Launch settings for DreamDaemon + + + + + If the BYOND web client can be used to connect to the game server + + + + + The level of + + + + + The first port uses. This should be the publically advertised port + + + + + The second port uses + + + + + The DreamDaemon startup timeout in seconds + + + + + Check if we match a given set of + + The to compare against + if they match, otherwise + + + + Configurable settings for + + + + + If starts when it's starts + + + + + If the server is undergoing a soft reset. This may be automatically set by changes to other fields + + + + + If the server is undergoing a soft shutdown + + + + + Represents a long running job + + + + + The ID + + + + + English description of the + + + + + Details of any exceptions caught during the + + + + + When the was started + + + + + When the stopped + + + + + If the was cancelled + + + + + The of if it can be cancelled + + + + + The required to cancel the + + + + + Represents configurable settings for a + + + + + The name of the committer + + + + + The e-mail of the committer + + + + + The username to access the git repository with + + + + + The token/password to access the git repository with + + + + + If commits created from testmerges are pushed to the remote + + + + + If test merge commits are signed with the username of the person who merged it. Note this only affects future commits + + + + + If test merge commits should be kept when auto updating. May cause merge conflicts which will block the update + + + + + If synchronization should occur when auto updating + + + + + Represents information about a current git revison + + + + + The revision sha + + + + + The sha of the most recent remote commit + + + + + Represents a merge of a GitHub pull request + + + + + The ID of the + + + + + When the was created + + + + + Layer of test merge data required internally + + + + + The title of the pull request + + + + + The body of the pull request + + + + + The URL of the pull request + + + + + The author of the pull request + + + + + Construct a + + + + + Construct a from a + + The to copy data from + + + + Represents a server + + + + + The ID of the + + + + + If the is enabled since users cannot be deleted. System users cannot be disabled + + + + + When the was created + + + + + The SID/UID of the on Windows/POSIX respectively + + + + + The name of the + + + + + The for the + + + + + The for the + + + + + for + + + + + + + + The IP address or URL of the IRC server + + + + + The port the server runs on + + + + + The nickname for the bot to use + + + + + If the connection should be made using SSL + + + + + The optional to use + + + + + The optional password to use + + + + + Construct an + + + + + Construct a from a + + The connection string + + + + + + + Represents the type of a password for a + + + + + Use server authentication + + + + + Use PLAIN sasl authentication + + + + + Use NickServ authentication + + + + + Represents a long running job on the server. Model is read-only, updates attempt to cancel the job + + + + + The that started the job + + + + + The that cancelled the job + + + + + Optional progress between 0 and 100 inclusive + + + + + Represents a git repository + + + + + The origin URL. If , the does not exist + + + + + The commit HEAD should point to. Not populated in responses, use instead for retrieval + + + + + The current for the + + + + + If the repository was cloned from GitHub.com this will be set with the owner of the repository + + + + + If the repository was cloned from GitHub.com this will be set with the name of the repository + + + + + The started by the if any + + + + + Do the equivalent of a git pull. Will attempt to merge unless is also specified in which case a hard reset will be performed after checking out + + + + + The branch or tag HEAD points to + + + + + for new s. Note that merges that conflict will not be performed + + + + + + + + The that was created with this + + + + + The s active in the + + + + + The s made from the + + + + + Represents basic server information + + + + + The version of the host + + + + + The version of the host + + + + + + + + The who created the + + + + + Parameters for creating a + + + + + The number of the pull request + + + + + The sha of the pull request revision to merge. If not specified, the latest commit shall be used (semi-unsafe) + + + + + Optional comment about the test + + + + + Represents a JWT returned by the API + + + + + The value of the JWT + + + + + When the expires + + + + + + + + The name of the default admin user + + + + + The default admin password + + + + + The who created this + + + + + For editing a given . Will never be returned by the API + + + + + Cleartext password of the + + + + + Rights for + + + + + User has no rights + + + + + User can edit themself and other s and also create others + + + + + User can gracefully restart the host + + + + + User can change + + + + + User can change their password + + + + + User can read info and rights of other users + + + + + Rights for + + + + + User has no rights + + + + + User may check the active installed BYOND version + + + + + User may list all installed BYOND versions + + + + + User may change the active BYOND version + + + + + User may cancel version installations + + + + + Rights for + + + + + User has no rights + + + + + User can change + + + + + User can change + + + + + User can change + + + + + User can change + + + + + User can read requires + + + + + User can read all chat settings except + + + + + User can create new + + + + + User can delete + + + + + User can change + + + + + Rights for + + + + + User has no rights + + + + + User may read files + + + + + User may write files + + + + + User may list files + + + + + User may delete empty folders + + + + + Rights for + + + + + User has no rights + + + + + User can read and + + + + + User can change both primary and secondary ports + + + + + User can change + + + + + User set + + + + + User can read all ports, , , , , and + + + + + User can change + + + + + User can enable + + + + + User can enable + + + + + User can immediately restart + + + + + User can immediately shutdown + + + + + User can start and disable and + + + + + User can change + + + + + Rights for + + + + + User has no rights + + + + + User may read status + + + + + User may trigger compiles + + + + + User may cancel compiles + + + + + User may modify + + + + + User may modify + + + + + User may list and read all s + + + + + User may modify + + + + + Rights for managing s + + + + + User has no rights + + + + + User can view s which they have any rights for + + + + + User can create s + + + + + User can rename s they can view + + + + + User can relocate s they can view + + + + + User can online s they can view + + + + + User can delete s they can view + + + + + User can view all s + + + + + User can change + + + + + User can change + + + + + Rights for an + + + + + User has no rights + + + + + Allow read access to for the + + + + + Allow write and delete access to for the + + + + + Allow adding additional to the + + + + + Rights for a + + + + + User has no rights + + + + + User may cancel synchronize operations + + + + + User may create the if it does not exist + + + + + User may directly set the sha the 's HEAD points to + + + + + User may fetch and merge GitHub pull requests + + + + + User may use the update feature + + + + + User may change and + + + + + User may change + + + + + User may read and change and + + + + + User may set to another git reference (not a SHA) + + + + + User may read all fields in the with the exception of + + + + + User may change and + + + + + User may delete the + + + + + User may cancel clone operations + + + + + Helper for s + + + + + Map of s to their respective flag s + + + + + Map a given to its respective + + The to lookup + The of the given + + + + Gets the role claim name used for a given + + The + The + A representing the claim role name + + + + Gets the role claim name used for a given and + + The + The right value + A representing the claim role name + + + + Check if a given is meant for an + + The to check + if is an instance right, otherwise + + + + The type of rights a model uses + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Routes to a server actions + + + + + The root controller + + + + + The controller + + + + + The controller + + + + + The controller + + + + + The controller + + + + + The controller + + + + + The controller + + + + + The controller + + + + + To be paired with for accessing s + + + + + Full combination of and + + + + + The controller + + + + + The controller + + + + + The controller + + + + + The controller + + + + + Apply an postfix to a + + The route + The ID + The with appended + + + + Get the /List postfix for a + + The route + The with /List appended + + + diff --git a/src/Tgstation.Server.Client/Tgstation.Server.Client.csproj b/src/Tgstation.Server.Client/Tgstation.Server.Client.csproj index e59a84d3da..db9df23a8e 100644 --- a/src/Tgstation.Server.Client/Tgstation.Server.Client.csproj +++ b/src/Tgstation.Server.Client/Tgstation.Server.Client.csproj @@ -25,11 +25,13 @@ true - bin\Release\netstandard2.0\Tgstation.Server.Client.xml + + 1701;1702 - 1701;1702;SA1652 + 1701;1702 + D:\tgstation-server\src\Tgstation.Server.Client\Tgstation.Server.Client.xml @@ -38,7 +40,7 @@ compile; build; native; contentfiles; analyzers - + all runtime; build; native; contentfiles; analyzers @@ -48,4 +50,7 @@ + + + diff --git a/src/Tgstation.Server.Client/Tgstation.Server.Client.xml b/src/Tgstation.Server.Client/Tgstation.Server.Client.xml new file mode 100644 index 0000000000..e6439d01e0 --- /dev/null +++ b/src/Tgstation.Server.Client/Tgstation.Server.Client.xml @@ -0,0 +1,1733 @@ + + + + Tgstation.Server.Client + + + + + + + + The for the + + + + + Construct an + + The value of + + + + + + + + + + + + + + + + + + + + + + + + + The for the + + + + + The s used by the + + + + + Backing field for + + + + + Construct an + + The value of + The value of + The value of + + + + + + + Main request method + + The resulting POCO type + The route to run + The body of the request + The method of the request + The optional for the request + The for the operation + A resulting in the response on success + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Occurs when the server returns an unknown response + + + + + Construct an using an + + The for the + The for the + + + + Construct an + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + Occurs when the API version of the client is not compatible with the server's + + + + + Construct an using an + + The for the + + + + Construct an + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + Exceptions thrown by s + + + + + The of the + + + + + The of the server's API + + + + + Construct a using an and + + The associated with the + The of the + + + + Construct a + + + + + Construct a with a + + The message for the + + + + Construct a with a and + + The message for the + The inner for the base + + + + + + + The for the + + + + + The for the + + + + + Construct a + + The value of + The value of + + + + + + + + + + + + + + + + The for the + + + + + The for the + + + + + Construct a + + The value of + The value of + + + + + + + + + + + + + + + + + + + + + + The for the + + + + + The for the + + + + + Sanitize a path for use in a GET + + The path to sanitize + The sanitized path + + + + Construct a + + The value of + The value of + + + + + + + + + + + + + + + + + + + + + + The for the + + + + + The for the + + + + + Construct a + + The value of + The value of + + + + + + + + + + + + + + + + + + + + + + The for the + + + + + The for the + + + + + Construct a + + The value of + The value of + + + + + + + + + + + + + + + + + + + For managing the installation + + + + + Get the active information + + The for the operation + A resulting in the active information + + + + Get all installed s + + The for the operation + A resulting in an of installed s + + + + Updates the information + + The information to update + The for the operation + A resulting in the updated information + + + + For managing the chat bots + + + + + List the s + + The for the operation + A resulting in a of the of the server + + + + Create a + + The to create + The for the operation + A resulting in the new + + + + Updates a 's setttings + + The to update + The for the operation + A resulting in the updated + + + + Get a 's setttings + + The to get + The for the operation + A resulting in the + + + + Delete a + + The to delete + The for the operation + A representing the running operation + + + + For managing files + + + + + List configuration files + + The path to the directory to list files in + The for the operation + A of s in the + + + + Read a file + + The file to read + The for the operation + A representing the running operation + + + + Overwrite a file + + The file to write + The for the operation + A resulting in the new + + + + Delete an empty + + The representing the directory to delete + The for the operation + A representing the running operation + + + + Creates an empty + + The representing the directory to create + The for the operation + A resulting in the new + + + + For managing + + + + + Get the represented by the + + The for the operation + A resulting in the information + + + + Start + + The for the operation + A resulting in the of the running operation + + + + Restart + + The for the operation + A resulting in the of the running operation + + + + Shutdown + + The for the operation + A resulting in the information + + + + Update . This may trigger + + The to update + The for the operation + A resulting in the information + + + + For managing the compiler + + + + + Get the information + + The for the operation + A resulting in the information + + + + Updates the setttings + + The to update + The for the operation + A representing the running operation + + + + Compile the current repository revision + + The for the operation + A resulting in the for the compile + + + + Gets the s of all s for the instance + + The for the operation + A resulting in a of s with only the field populated + + + + Get a + + The to get + The for the operation + A resulting in the + + + + For managing a single + + + + + The used to create the + + + + + Access the + + + + + Access the + + + + + Access the + + + + + Access the + + + + + Access the + + + + + Access the + + + + + Access the + + + + + Access the + + + + + For managing s + + + + + Get the associated with the logged on user + + The for the operation + A resulting in the associated with the logged on user + + + + Get a specific + + The to get + The for the operation + A resulting in the requested + + + + Get the s in the + + The for the operation + A resulting in a of s in the instance + + + + Update a + + The to update + The for the operation + A representing the running operation + + + + Create a + + The to create + The for the operation + A reulting in the new + + + + Delete a + + The to delete + The for the operation + A representing the running operation + + + + Access to running jobs + + + + + List the s in the + + The for the operation + A resulting in a of the s in the + + + + List the active s in the + + The for the operation + A resulting in a of the active s in the + + + + Get a + + The to get + The for the operation + A resulting in the + + + + Cancels a + + The to cancel + The for the operation + A representing the running operation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The for the + + + + + Construct a + + The value of + The value of + + + + + + + The for the + + + + + The for the + + + + + Construct an + + The value of + The value of + + + + + + + + + + + + + + + + + + + + + + For managing the + + + + + Get the represented by the + + The for the operation + A resulting in the + + + + Update the + + The to update + The for the operation + A resulting in the updated + + + + Clones a + + The to clone + The for the operation + A resulting in the updated + + + + Deletes the + + The for the operation + A resulting in the updated + + + + + + + The for the + + + + + The for the + + + + + Construct a + + The value of + The value of + + + + + + + + + + + + + + + + + + + The for the + + + + + The for the + + + + + Construct a + + The value of + The value of + + + + + + + + + + + + + + + + Occurs when the client performs an action that would result in data conflict + + + + + Construct an with a and + + The for the + The for the + + + + Construct a + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + + + + + + + The real + + + + + Construct an + + + + + + + + + + + For managing server administration + + + + + Get the represented by the + + The for the operation + A resulting in the represented by the + + + + Updates the setttings + + The to update + The for the operation + A representing the running operation + + + + Restarts the TGS server + + The for the operation + A representing the running operation + + + + Web interface for the API + + + + + The the uses + + + + + The pointing the tgstation-server + + + + + The request timeout + + + + + Adds a to the request pipeline + + The to add + + + + Run an HTTP PUT request + + The type to of the request body + The type of the response body + The server route to make the request to + The request body + The for the operation + A resulting in the response body as a + + + + Run an HTTP PUT request + + The type of the response body + The server route to make the request to + The for the operation + A resulting in the response body as a + + + + Run an HTTP GET request + + The type of the response body + The server route to make the request to + The for the operation + A resulting in the response body as a + + + + Run an HTTP POST request + + The type to of the request body + The type of the response body + The server route to make the request to + The request body + The for the operation + A resulting in the response body as a + + + + Run an HTTP POST request + + The type of the response body + The server route to make the request to + The for the operation + A resulting in the response body as a + + + + Run an HTTP POST request + + The type to of the request body + The server route to make the request to + The request body + The for the operation + A representing the running operation + + + + Run an HTTP DELETE request + + The server route to make the request to + The for the operation + A representing the running operation + + + + Run an HTTP PUT request + + The type to of the request body + The type of the response body + The server route to make the request to + The request body + The to make the request to + The for the operation + A resulting in the response body as a + + + + Run an HTTP PUT request + + The type of the response body + The server route to make the request to + The to make the request to + The for the operation + A resulting in the response body as a + + + + Run an HTTP PATCH request + + The type of the response body + The server route to make the request to + The to make the request to + The for the operation + A resulting in the response body as a + + + + Run an HTTP GET request + + The type of the response body + The server route to make the request to + The to make the request to + The for the operation + A resulting in the response body as a + + + + Run an HTTP POST request + + The type to of the request body + The type of the response body + The server route to make the request to + The request body + The to make the request to + The for the operation + A resulting in the response body as a + + + + Run an HTTP DELETE request + + The server route to make the request to + The to make the request to + The for the operation + A representing the running operation + + + + Run an HTTP DELETE request + + The type to of the request body + The server route to make the request to + The request body + The to make the request to + The for the operation + A representing the running operation + + + + Run an HTTP DELETE request + + The type of the response body + The server route to make the request to + The to make the request to + The for the operation + A resulting in the response body as a + + + + For creating s + + + + + Create an + + The base + The for the + A new + + + + For sending HTTP requests + + + + + The request timeout + + + + + Send an HTTP request + + The + The for the operation + A resulting in the of the request + + + + For managing s + + + + + Get all s for s the user can view + + The for the operation + A resulting in a of all s the user can view + + + + Create or attach an + + The to create. will be ignored + The for the operation + A resulting in the created or attached + + + + Relocates, renamed, and/or on/offlines an + + The to update + The for the operation + A resulting in the updated + + + + Get a specific + + The to get + The for the operation + A resulting in the + + + + Deletes an + + The to delete + The for the operation + A representing the running operation + + + + Create an for a given + + The to create an for + A new + + + + + + + The for the + + + + + Map of already created s + + + + + Construct an + + The value of + + + + + + + + + + + + + + + + + + + + + + Occurs when the client attempts to perform an action they do not have the rights for + + + + + Construct an + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + For logging HTTP requests and responses + + + + + Log a request + + The representing the request + The for the operation + A representing the running operation + + + + Log a response + + The representing the request + The for the operation + A representing the running operation + + + + Main client for communicating with a server + + + + + The connected server + + + + + The used to access the server + + + + + The connection timeout + + + + + Access the + + + + + Access the + + + + + Access the + + + + + The of the + + The for the operation + A resulting in the of the target server + + + + Adds a to the request pipeline + + The to add + + + + Factory for creating s + + + + + Create a + + The URL to access TGS + The username to for the + The password for the + The representing timeout for the connection + The for the operation + A resulting in a new + + + + Create a + + The URL to access TGS + The to access the API with + The representing timeout for the connection + A new + + + + For managing s + + + + + Read the current user's information and general rights + + The for the operation + A resulting in the current + + + + Get a specific + + The to get + The for the operation + A resulting in the requested + + + + List all s + + The for the operation + A resulting in a of all s + + + + Create a new + + The used to create the new + The for the operation + The new + + + + Update a + + The used to update the + The for the operation + The updated + + + + Occurs when the client tries to use a currently unsupported API + + + + + Construct an + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + Occurs when a GitHub rate limit occurs + + + + + Construct an + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + Occurs when the client provides invalid credentials + + + + + Construct an + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + + + + + + + + + + + + + + + + + + + + + + The for the + + + + + Backing field for + + + + + Construct a + + The value of + The value of + + + + + + + + + + + + + + + + The for the + + + + + The for the + + + + + Construct a + + The value of + + + + + + + + + + Occurs when an error occurs in the server + + + + + The raw HTML of the error + + + + + Construct an + + + + + Construct an with + + The raw HTML response of the + + + + Construct an with a and + + The message for the + The inner for the base + + + + Occurs when the client makes a request while the server is starting or stopping + + + + + Construct an + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + Occurs when the client provides invalid credentials + + + + + Construct an + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + Occurs when a response is received that did not deserialize to one of the expected + + + + + Construct an with the of a response body and the + + The body of the response + The for the + + + + Construct a + + + + + Construct an with a + + The message for the + + + + Construct an with a and + + The message for the + The inner for the base + + + + + + + The for the + + + + + Construct an + + The value of + + + + + + + + + + + + + + + + + + diff --git a/src/Tgstation.Server.Host.Console/Tgstation.Server.Host.Console.csproj b/src/Tgstation.Server.Host.Console/Tgstation.Server.Host.Console.csproj index d007c3675a..9e59c6abb4 100644 --- a/src/Tgstation.Server.Host.Console/Tgstation.Server.Host.Console.csproj +++ b/src/Tgstation.Server.Host.Console/Tgstation.Server.Host.Console.csproj @@ -25,7 +25,7 @@ compile; build; native; contentfiles; analyzers - + all runtime; build; native; contentfiles; analyzers @@ -44,4 +44,7 @@ + + + diff --git a/src/Tgstation.Server.Host.Service/Tgstation.Server.Host.Service.csproj b/src/Tgstation.Server.Host.Service/Tgstation.Server.Host.Service.csproj index f697563016..eb704ca548 100644 --- a/src/Tgstation.Server.Host.Service/Tgstation.Server.Host.Service.csproj +++ b/src/Tgstation.Server.Host.Service/Tgstation.Server.Host.Service.csproj @@ -102,10 +102,15 @@ 2.1.1 - + all runtime; build; native; contentfiles; analyzers + + + stylecop.json + + \ No newline at end of file diff --git a/src/Tgstation.Server.Host.Watchdog/Tgstation.Server.Host.Watchdog.csproj b/src/Tgstation.Server.Host.Watchdog/Tgstation.Server.Host.Watchdog.csproj index c463b20bc6..a1360291ef 100644 --- a/src/Tgstation.Server.Host.Watchdog/Tgstation.Server.Host.Watchdog.csproj +++ b/src/Tgstation.Server.Host.Watchdog/Tgstation.Server.Host.Watchdog.csproj @@ -25,7 +25,7 @@ compile; build; native; contentfiles; analyzers - + all runtime; build; native; contentfiles; analyzers @@ -36,4 +36,8 @@ PreserveNewest + + + + diff --git a/src/Tgstation.Server.Host/Tgstation.Server.Host.csproj b/src/Tgstation.Server.Host/Tgstation.Server.Host.csproj index e094b2f28a..5e7fc42d01 100644 --- a/src/Tgstation.Server.Host/Tgstation.Server.Host.csproj +++ b/src/Tgstation.Server.Host/Tgstation.Server.Host.csproj @@ -46,7 +46,7 @@ - + all runtime; build; native; contentfiles; analyzers @@ -79,4 +79,7 @@ + + + diff --git a/tgstation-server.sln b/tgstation-server.sln index 599acf7da1..d502fc155d 100644 --- a/tgstation-server.sln +++ b/tgstation-server.sln @@ -24,6 +24,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "build", "build", "{6FF654E6 build\BuildDox.ps1 = build\BuildDox.ps1 build\Dockerfile = build\Dockerfile build\install_byond.sh = build\install_byond.sh + build\stylecop.json = build\stylecop.json build\test_core.sh = build\test_core.sh build\tgs.docker.sh = build\tgs.docker.sh build\tgs.ico = build\tgs.ico