From d83baf79cb637d5719740286258a1b4bbcb192c3 Mon Sep 17 00:00:00 2001 From: Dominion Date: Sun, 11 Jun 2023 18:07:00 -0400 Subject: [PATCH] Very low effort dox updates --- docs/API.dox | 3 ++- docs/Features.dox | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/API.dox b/docs/API.dox index b99ecd7dfc..a859e36c47 100644 --- a/docs/API.dox +++ b/docs/API.dox @@ -9,7 +9,7 @@ TGS has a, from code, generated OpenAPI 3.0 specification. It is much more autho The most up to date version should be found in the most recent appveyor build artifacts. It is also included in release artifacts. -You can use the API explorer SwaggerUI to interact with it: https://petstore.swagger.io +You can use the API explorer SwaggerUI to interact with it: https://tgstation.github.io/tgs-api-doc-host/ @section api_intro Introduction @@ -35,6 +35,7 @@ This document will reference the canonical C# models in the @ref Tgstation.Serve - Fields marked 'Required' should be ignored, this is a semantic for the backing SQL database - Id fields must be specified when making POST requests - All other fields are optional and may be absent from responses or requests unless otherwise specified +- Request models can be found in @ref Tgstation.Server.Api.Models.Request. Response models can be found in @ref Tgstation.Server.Api.Models.Response. @section api_header Headers diff --git a/docs/Features.dox b/docs/Features.dox index 5b157598ec..3c1430740f 100644 --- a/docs/Features.dox +++ b/docs/Features.dox @@ -57,6 +57,7 @@ tgstation-server is a BYOND server managment suite. It includes all the followin - Logs can be downloaded via the API - Supports Elasticsearch ingesting - Able to self update with user input + - Updates are sourced from our (or anyone else's if configured to do so) GitHub releases or uploaded directly by the user. - Swarm system to coordinate servers across systems - Database backend supporting several providers - Microsoft SQL Server