mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-30 00:22:40 +01:00
Various DM and repo fixes
This commit is contained in:
+14
-4
@@ -9,7 +9,7 @@ The TGS4 API is designed to be a fully realized RESTful service. Once hosted, fo
|
||||
|
||||
Routes and their usages are defined as follows
|
||||
|
||||
`[I (If Instance is required)] <Http Method> "<Route>" [Request Model] => <Response Model>`
|
||||
[I (If Instance is required)] <`Http Method`> "<`Route`>`" [Request Model] => <`Response Model`>
|
||||
|
||||
@section api_lib Official Libraries
|
||||
|
||||
@@ -29,7 +29,7 @@ This document will reference the canonical C# models in the @ref Tgstation.Serve
|
||||
|
||||
@section api_header Headers
|
||||
|
||||
TGS4 expects this set of headers. Failure to provide them may result in
|
||||
TGS4 expects this set of headers. Failure to provide them may result in 400 error responses
|
||||
|
||||
- User-Agent: The user agent product header value of the calling program. Should be in the form Agent/Version (i.e. SomeTgsClient/1.2.4)
|
||||
- Accept: application/json
|
||||
@@ -284,14 +284,14 @@ git pull (Only if @ref Tgstation.Server.Api.Models.Repository.Reference is set):
|
||||
}
|
||||
@endcode
|
||||
|
||||
git checkout <commit sha> (Unsets @ref Tgstation.Server.Api.Models.Repository.Reference):
|
||||
`git checkout <commit sha> (Unsets @ref Tgstation.Server.Api.Models.Repository.Reference):`
|
||||
@code{.json}
|
||||
{
|
||||
"checkoutSha": "<commit sha>"
|
||||
}
|
||||
@endcode
|
||||
|
||||
git checkout -f <branch or tag> && git clean -fxd (Sets @ref Tgstation.Server.Api.Models.Repository.Reference):
|
||||
`git checkout -f <branch or tag> && git clean -fxd (Sets @ref Tgstation.Server.Api.Models.Repository.Reference):`
|
||||
@code{.json}
|
||||
{
|
||||
"reference": "<branch or tag>"
|
||||
@@ -364,4 +364,14 @@ The job object returned represents the compile job
|
||||
{}
|
||||
@endcode
|
||||
|
||||
The compiler endpoint is also used to read compile jobs
|
||||
|
||||
To list successful compile jobs ids use:
|
||||
|
||||
I GET "/DreamMaker/List" => Array of @ref Tgstation.Server.Api.Models.CompileJob
|
||||
|
||||
To get a specific compile job use:
|
||||
|
||||
I GET "/DreamMaker/{CompileJobId}" => @ref Tgstation.Server.Api.Models.CompileJob
|
||||
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user