diff --git a/docs/API.dox b/docs/API.dox index 2eb1a0f76a..e1e2635fa1 100644 --- a/docs/API.dox +++ b/docs/API.dox @@ -61,7 +61,7 @@ TGS will only every return the response codes listed here - 408: Request timeout. The client took to long to continue a request - 409: Conflict. Documented in the requests that use them - 410: Gone. Attempted to access/modify a resource that ideally should have been ready, but isn't or no longer is -- 422: Unprocessable Entity: Used specifically when an operation that requires a server restart is unable to be performed due to the @ref Tgstation.Server.Host.Watchdog not being present in the deployment. Blame MSO. Response body contains an @ref Tgstation.Server.Api.Models.ErrorMessage +- 422: Unprocessable Entity: Used specifically when an operation that requires a server restart is unable to be performed due to the @ref Tgstation.Server.Host.Watchdog not being present in the deployment. Should not happen with a proper server configuration. Response body contains an @ref Tgstation.Server.Api.Models.ErrorMessage - 424: Failed Dependency: When a request that depends on the GitHub API fails for a reason other than rate limiting. Check server logs, usually this indicates a bad access token. - 426: Upgrade required: Used when the client's API version is not compatible with the server's. Response body contains an @ref Tgstation.Server.Api.Models.ErrorMessage - 429: Rate limited. Used with operations that rely on GitHub.com. If a rate limit is hit for an operation this will be returned. Response will contain a Retry-After header @@ -245,8 +245,6 @@ The @ref Tgstation.Server.Api.Models.Internal.ChatBot.ConnectionString must diff For IRC chat bots see @ref Tgstation.Server.Api.Models.IrcConnectionStringBuilder For Discord chat bots see @ref Tgstation.Server.Api.Models.DiscordConnectionStringBuilder -For Discord chat bots it should be the bot's Token - A specific bot's settings may be retrieved with: I GET "/Chat/{ChatBotId}" => @ref Tgstation.Server.Api.Models.ChatBot