Two conflicts, both additive: schema.sql and purge.sql keep both phases' tables. Swagger fragment (61 paths) and routes.manifest (67 routes) regenerated against the pinned core; 455 server and 58 client tests pass. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01E14m6SuuY6i1vASFeGDBeY
10364 lines
365 KiB
JSON
10364 lines
365 KiB
JSON
{
|
||
"paths": {
|
||
"/api/v1/admin/rust/config/{serverId}/file": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "One configuration file",
|
||
"description": "The file’s text, the version a save must present back, and the field list the generated form is drawn from — types, keys, and which values are credentials. A file that is already broken on disk still opens, with the parse error, because the raw tier is the only thing that can fix it.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "path",
|
||
"in": "query",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The file and the reading of it"
|
||
},
|
||
"400": {
|
||
"description": "Not a configuration path"
|
||
},
|
||
"503": {
|
||
"description": "The sidecar or the game is unreachable"
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Save a configuration file and reload its plugin",
|
||
"description": "Send `edits` (the generated form: pointers and literals, type-preserving) or `text` (the raw tier: the whole document). `version` must match what the host holds or the save is refused 409 with the current file. The game backs the file up, writes it, reloads the named plugin, and **restores the old file automatically** if the plugin fails to load. With a plugin to reload, the answer comes as soon as the file is written — `pending: true` and `write.id` — and the outcome is read from `GET …/writes/{writeId}` once the reload settles. Without one, the answer is final.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Written and reloading (`pending`, with the write’s id), or the final outcome when nothing was reloaded"
|
||
},
|
||
"400": {
|
||
"description": "Invalid body, an edit the form may not make, or a locked key"
|
||
},
|
||
"409": {
|
||
"description": "The file changed on the host since it was read"
|
||
},
|
||
"503": {
|
||
"description": "The sidecar or the game is unreachable"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"path": {
|
||
"example": "any"
|
||
},
|
||
"edits": {
|
||
"example": "any"
|
||
},
|
||
"reload": {
|
||
"example": "any"
|
||
},
|
||
"version": {
|
||
"example": "any"
|
||
},
|
||
"text": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/config/{serverId}/files": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Every plugin configuration file on one server",
|
||
"description": "A live recursive walk of the game host’s configuration directory, grouped by the plugin each file probably belongs to, plus every plugin currently loaded. The root comes from the mod framework, so it is `oxide/config` on Oxide and `carbon/configs` on Carbon. Files past the size limit are listed and marked un-editable rather than hidden. The game’s data directory is never walked.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The configuration tree and the loaded plugins"
|
||
},
|
||
"502": {
|
||
"description": "Bad Gateway"
|
||
},
|
||
"503": {
|
||
"description": "The sidecar or the game is unreachable"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/config/{serverId}/writes": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Recent configuration writes",
|
||
"description": "The audit trail for one server: who changed which field, from what to what, whether the plugin reloaded, and whether the change was rolled back. Refused and unreachable attempts are recorded too — an operator asking why a setting is not what they set needs to see that somebody tried. Values of credential-shaped fields are never stored.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "limit",
|
||
"in": "query",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The recent writes, newest first"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/config/{serverId}/writes/{writeId}": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "One configuration write, while its reload settles",
|
||
"description": "A save that reloads a plugin answers as soon as the file is written, with `pending: true` and this write’s id; the reload can take longer than a request should, behind a cold compile. Poll this until `outcome` leaves `reloading`: `applied`, or `rolled-back` with the reason, the server’s log, and `restored` (whether the plugin came back on its old file). `lost` means the plugin never reported — it was reloaded, or the link dropped — so re-read the file.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "writeId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The write and how far it has got"
|
||
},
|
||
"404": {
|
||
"description": "No such write on that server"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "The permission manager: servers, policies and what waits for a person",
|
||
"description": "Every configured server with its policy for a change made in the game (`auto-adopt`, `adopt`, `revoke`; D161) and its sync state, and every row waiting for a person: each change under `adopt`, an event’s grant removed in the game, a hand-edited style field, and notices of a shared group split off for one server (D190). `chatFields` lists the twelve BetterChat fields for the style editor.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The overview",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustPermissionOverview"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/catalogue": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Permission names the servers have registered",
|
||
"description": "Every permission name the loaded plugins on each server registered, from the last inventory, with the plugin that registered it (`owner`) — null for a name no plugin owns, which on Carbon is its built-in modules’.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Every registered name, which servers know it, and who registered it",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustPermissionCatalogue"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/drift/{id}/accept": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Accept a removal made in the game",
|
||
"description": "The site stops giving it on that server: deleted when it was that server’s alone, an exception when it reached further, a split when it was a shared group’s (D190).",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Accepted"
|
||
},
|
||
"400": {
|
||
"description": "Only a removal can be accepted"
|
||
},
|
||
"404": {
|
||
"description": "No such change"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/drift/{id}/adopt": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Adopt a change made in the game",
|
||
"description": "An addition (or a changed group) becomes the site’s own for that server — the same write auto-adopt makes. For a `chat-field` row, the game’s value becomes the group’s style; 409 when the group has no style or the value is not one the site accepts.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Adopted"
|
||
},
|
||
"400": {
|
||
"description": "That change was a removal"
|
||
},
|
||
"404": {
|
||
"description": "No such change"
|
||
},
|
||
"409": {
|
||
"description": "Conflict"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/drift/{id}/dismiss": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Dismiss a notice",
|
||
"description": "A split notice (D190) or an event’s grant that was pushed back. Nothing in any game changes.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Dismissed"
|
||
},
|
||
"404": {
|
||
"description": "No such notice"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/drift/{id}/restore": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Put back what the game removed or changed",
|
||
"description": "The next sync pushes the site’s version again.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"202": {
|
||
"description": "Queued for the next sync"
|
||
},
|
||
"400": {
|
||
"description": "Only a removal or a changed group can be put back"
|
||
},
|
||
"404": {
|
||
"description": "No such change"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/drift/{id}/revoke": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Undo an addition made in the game",
|
||
"description": "Queued: a server that is down keeps the instruction until it comes back. For a `chat-field` row it puts the site’s value back.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"202": {
|
||
"description": "Queued for the next sync"
|
||
},
|
||
"400": {
|
||
"description": "Only an addition can be revoked"
|
||
},
|
||
"404": {
|
||
"description": "No such change"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/exceptions/{id}": {
|
||
"delete": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Give a grant back to the one server it was kept off",
|
||
"description": "",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Removed"
|
||
},
|
||
"404": {
|
||
"description": "No such exception"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/groups/{id}": {
|
||
"patch": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Change a group’s title, rank, parent or chat style",
|
||
"description": "The title is kept verbatim. `chat` is the group’s BetterChat style — all twelve fields as text; `null` removes it; absent leaves it. With `onlyHere` and `serverId` on a shared group, that server’s copy is split off first and only it changes (D190).",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Saved; `id` is the group that changed, a new copy if it was split"
|
||
},
|
||
"400": {
|
||
"description": "An invalid style"
|
||
},
|
||
"404": {
|
||
"description": "No such group"
|
||
},
|
||
"409": {
|
||
"description": "Conflict"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"chat": {
|
||
"example": "any"
|
||
},
|
||
"onlyHere": {
|
||
"example": "any"
|
||
},
|
||
"serverId": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Delete a group",
|
||
"description": "From the site and, at the next sync, from every server it is on. A built-in group (`default`, `admin`, Carbon’s `moderator`) is never removed from a game.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Deleted"
|
||
},
|
||
"404": {
|
||
"description": "No such group"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/groups/{id}/members": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Put a player in a group",
|
||
"description": "A Steam id is a member as itself (D188); a website account reaches every Steam id it links (D28). A member who has never connected to a server is pending there until their first connection.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Added"
|
||
},
|
||
"400": {
|
||
"description": "No subject named"
|
||
},
|
||
"404": {
|
||
"description": "No such group"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"onlyHere": {
|
||
"example": "any"
|
||
},
|
||
"serverId": {
|
||
"example": "any"
|
||
},
|
||
"steamId": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/groups/{id}/members/clear": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Remove every member of a group",
|
||
"description": "",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Emptied"
|
||
},
|
||
"404": {
|
||
"description": "No such group"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"onlyHere": {
|
||
"example": "any"
|
||
},
|
||
"serverId": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/groups/{id}/members/remove": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Take a player out of a group",
|
||
"description": "Both ways they can be in it: as the Steam id, and as the website account it is linked to.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Removed"
|
||
},
|
||
"404": {
|
||
"description": "No such group"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"onlyHere": {
|
||
"example": "any"
|
||
},
|
||
"serverId": {
|
||
"example": "any"
|
||
},
|
||
"steamId": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/groups/{id}/permissions": {
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Replace what a group carries",
|
||
"description": "The whole list: the screen’s toggles, Grant all and Revoke all each send it. With `onlyHere` and `serverId` on a shared group, that server’s copy is split off first (D190).",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Saved; `id` is the group that changed"
|
||
},
|
||
"404": {
|
||
"description": "No such group"
|
||
},
|
||
"409": {
|
||
"description": "Conflict"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"onlyHere": {
|
||
"example": "any"
|
||
},
|
||
"serverId": {
|
||
"example": "any"
|
||
},
|
||
"permissions": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/groups/{id}/servers": {
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Share a group, or stop sharing it",
|
||
"description": "`allServers` puts it on every server, including servers added later; otherwise `servers` lists them (D189). A chosen server that already has its own group of this name answers 409 with each one’s permissions; repeat with `replace` listing the ids to replace.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Saved"
|
||
},
|
||
"404": {
|
||
"description": "No such group"
|
||
},
|
||
"409": {
|
||
"description": "A chosen server has its own group of this name"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/groups/{id}/split": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Give one server its own copy of a shared group",
|
||
"description": "The copy carries the same permissions, members and style, on that server only, and the shared group stops covering it (D190).",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Split; `id` is the copy"
|
||
},
|
||
"400": {
|
||
"description": "Bad Request"
|
||
},
|
||
"404": {
|
||
"description": "No such group"
|
||
},
|
||
"409": {
|
||
"description": "That group is not on that server"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"serverId": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/servers/{serverId}": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "One server’s permissions, as the screen shows them",
|
||
"description": "Plugins grouped by the plugin that registered each permission, never by prefix; the groups on the server and where else each one is (D189); every player holding anything there, named by linked account and in-game name, or Steam id (D163); what the site wants and why, what has landed, and what the last report said did not — the facts every toggle’s state is read from (U-1).",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The server view",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustPermissionServer"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/servers/{serverId}/grant": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Grant permissions to one player (a toggle, or Grant all)",
|
||
"description": "On this server, or with `everywhere` on every server. A linked Steam id is granted as its website account and reaches every account the person links (D28); an unlinked one as itself (D188). A grant kept off this server by an exception has the exception removed instead.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "How many were granted, and how many exceptions removed"
|
||
},
|
||
"400": {
|
||
"description": "No subject named"
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"everywhere": {
|
||
"example": "any"
|
||
},
|
||
"permissions": {
|
||
"example": "any"
|
||
},
|
||
"steamId": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/servers/{serverId}/groups": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Create a group on one server",
|
||
"description": "A group belongs to one server unless an admin shares it (D189). A server cannot have two groups of one name.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "Created; the body carries its id"
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
},
|
||
"409": {
|
||
"description": "This server already has a group of that name"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/servers/{serverId}/players": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Find a player seen on a server",
|
||
"description": "By in-game name, Steam id or linked account name, among the players this server has seen — to grant to somebody who holds nothing yet. At most 25, newest first.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "q",
|
||
"in": "query",
|
||
"description": "Part of a name, Steam id or account name",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Matching players"
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/servers/{serverId}/policy": {
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Set what a change made in the game becomes",
|
||
"description": "`auto-adopt` (the default) makes it the site’s own for that server; `adopt` puts each one to a person; `revoke` undoes it (D161).",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Saved"
|
||
},
|
||
"400": {
|
||
"description": "Not a policy"
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"policy": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/servers/{serverId}/revoke": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Revoke permissions from one player (a toggle, or Revoke all)",
|
||
"description": "Every direct grant that puts the permission on this server stops doing so: one scoped to this server is deleted; one that reaches further is deleted with `everywhere`, and otherwise gains an exception for this server (D190). What the player holds through a group or from an event is reported back in `untouched`, not changed.",
|
||
"parameters": [
|
||
{
|
||
"name": "serverId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "How many grants changed, and what could not be"
|
||
},
|
||
"400": {
|
||
"description": "No subject named"
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"everywhere": {
|
||
"example": "any"
|
||
},
|
||
"permissions": {
|
||
"example": "any"
|
||
},
|
||
"steamId": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/permissions/sync": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Read, reconcile and push now",
|
||
"description": "Runs the loop’s pass immediately for one server or all of them — read the store, settle what changed in the game by the server’s policy, push — and answers with each server’s state.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The state of every server after the pass",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustPermissionSyncResult"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"req": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/servers": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Every configured Rust server",
|
||
"description": "The operator’s server rows with their sidecar URLs, whether a token is stored, and whether each sidecar was reachable on the last poll. The token itself is never returned.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The configured servers",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustAdminServerList"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/servers/{id}": {
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Create or update a Rust server",
|
||
"description": "Writes one server row. `sidecarToken` is write-only — send it to set or rotate the credential, and omit it or send an empty string to leave the stored one untouched. The id is the slug every URL under the module carries. The wipe schedule (`wipeRule`, `wipeDay`, `wipeTime`, `wipeTz`, `wipeAnchor`, `wipeOnceAt`) is written only when `wipeRule` is present, so a body without it leaves the stored schedule alone. `wipeRule` is `none`, `forced`, `weekly` or `biweekly`; a weekly or biweekly rule needs `wipeDay` (0 = Sunday), `wipeTime` (`HH:MM`) and an IANA `wipeTz`, and a biweekly rule a `wipeAnchor` date on that day. `wipeOnceAt` is a one-off wipe in the future. A 400 carries one sentence per problem in `errors`.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Saved"
|
||
},
|
||
"400": {
|
||
"description": "Invalid body"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustServerSave"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Remove a Rust server",
|
||
"description": "Deletes the server row and the observed state that hangs off it. It does not touch the sidecar or the game host — those are removed with the installer.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Deleted"
|
||
},
|
||
"404": {
|
||
"description": "Not Found"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/servers/{id}/integrations": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Which optional mods a server has loaded",
|
||
"description": "Asks the game, live, whether BetterChat and PopupNotifications are loaded, and which versions. Both are optional: without BetterChat titles and group styles wait for it, and without PopupNotifications a popup is refused with a reason. `integrations` is null when the game could not be asked or its plugin is older than protocol 12, and `status` then says why.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "What the server has loaded",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustIntegrations"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No such server, or it is disabled"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/servers/{id}/map/fetch": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Fetch a server’s map picture again",
|
||
"description": "Asks the game what its map is and fetches the picture again, whatever this site already holds. The site does this by itself the first time it sees a new map when the game has a picture to give; this is the button for when that did not happen. `outcome` is `fetched`, `current` (the stored picture is this map’s), `none` (the game has no picture, and Render now is the way to get one) or `failed`, with a sentence in `message`. One fetch per server at a time: a second answers 409.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "What the fetch did"
|
||
},
|
||
"404": {
|
||
"description": "No such server, or it is disabled"
|
||
},
|
||
"409": {
|
||
"description": "A fetch is already running for this server"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
},
|
||
"502": {
|
||
"description": "The game or its sidecar did not give a picture; the stored one is kept"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/servers/{id}/map/render": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Ask a server to draw its own map",
|
||
"description": "**This stalls the game server** while it draws — about 8.5 seconds on a 3000 map, longer on a larger one — and nothing on it moves for that time. It exists for a server without Rust+ (`app.port`), whose game keeps no picture of its map, and is refused when a picture already exists. Answers 202 as soon as the game accepts; the picture is fetched when the render finishes, and kept by the game so a restart on the same map does not need another.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"202": {
|
||
"description": "The game accepted and will draw on its next frame"
|
||
},
|
||
"404": {
|
||
"description": "No such server, or it is disabled"
|
||
},
|
||
"409": {
|
||
"description": "A picture already exists, or a render is already running"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
},
|
||
"502": {
|
||
"description": "Bad Gateway"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/servers/{id}/test": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Probe a server’s sidecar",
|
||
"description": "Calls the sidecar’s health endpoint with the stored credential and reports what came back — whether it answered, whether the bridge plugin is connected to it, and which protocol version it speaks. This is the one route that tells a wrong URL from a wrong token from a mismatched version.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "What the sidecar said",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustSidecarProbe"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/servers/{id}/titles": {
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Set a server’s chat titles",
|
||
"description": "Replaces the server’s title rules and how many titles a player shows. A rule ranks the CURRENT wipe by one of the title categories (`RustTitleSettings`) and gives its top N (1–10) a title; only a stat above zero counts, so a fresh wipe gives no titles. A rule’s `text` may be empty, meaning the category’s title (the admin’s, else the module’s default); `playtime` has no default and needs its own. A text that was typed but is only markup is refused. Rules are in precedence order, at most ten. `mode` is `first` (the first rule a player meets), `all`, or `upto` `max` (1–5). The titles are shown in game by BetterChat when it is loaded — they are pushed whether or not it is, and it shows them as soon as it is — and on the web and app leaderboards. A 400 carries one sentence per problem in `errors`.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Saved; answers the server’s settings as stored"
|
||
},
|
||
"400": {
|
||
"description": "A rule, the mode or N is not valid"
|
||
},
|
||
"404": {
|
||
"description": "No such server"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustTitleSettings"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/title-categories": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "The chat-title categories and their titles",
|
||
"description": "Every category a title rule can rank that has a shipped title (PLAN_REDESIGNS §5, D172), with its label, the module’s default, the admin’s own title if they set one, and `current`, what a rule with no text of its own shows. The admin’s title is for the whole site (D175).",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The categories",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"categories": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustTitleCategory"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/title-categories/{stat}": {
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Rename a chat-title category, or reset it",
|
||
"description": "Sets the site’s own title for one category (D175): at most 24 characters, markup characters taken out as a rule’s are. An empty `text` resets the category to the module’s default. Every rule of this category with no text of its own shows the new title on every server from the next push; a rule that carries its own text keeps it. Answers the whole list.",
|
||
"parameters": [
|
||
{
|
||
"name": "stat",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The category id, for example animalkills"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Saved; answers every category"
|
||
},
|
||
"400": {
|
||
"description": "The title is too long, or only markup"
|
||
},
|
||
"404": {
|
||
"description": "No such category"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"text": {
|
||
"type": "string",
|
||
"maxLength": 24,
|
||
"example": "Hunter"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/visibility": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Who may see who is online, and who may see a clan roster",
|
||
"description": "The presence fleet default and every server’s optional override. It governs the Online list, every feed item that names a player who was on the server (connects, respawns, deaths, chat, tallies) and the leaderboard’s `lastSeen`. The default is `staff`: nothing names who is online until an operator widens it. The player count is public at every setting. `clans` carries the clan roster audience (default `members`: the clan’s own linked members, and staff) and each server’s clan board — whether it is current, at the game’s 100-clan ceiling, or running the uMod Clans plugin, whose clans are not Teams. `map` carries the live map’s switches: each layer’s fleet audience (`world` and `events` public, `players` and `bases` staff by default), the own-and-mates switch (on), each server’s overrides, and what each server’s map picture is — its source, the map it is of, when it was fetched, and how long a render would stall that server.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The fleet default and each server",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustVisibility"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
},
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Change who may see who is online, who may see a clan roster, or which servers say news in chat",
|
||
"description": "Sets the presence fleet default, one or more server overrides, the clan roster audience, the per-server news-in-chat switches, or any of them together. A server set to `null` follows the fleet default again. `news` maps a server id to `true` or `false`: whether a published news post is also said in the in-game chat of that server (off by default). `newsDelivery` maps a server id to `chat` or `popup`: where that post goes — a popup needs PopupNotifications on the server, and one without it refuses the post with a reason. Validated whole before anything is written: a request naming a server that does not exist changes nothing. Widening the clan roster audience also shows which members are online to that audience, because a roster row carries it. `map` is `{ fleet, servers }`: `fleet` maps a layer (`world`, `events`, `players`, `bases`) to an audience and `mates` to true or false; `servers` maps a server id to the same shape, where null follows the fleet. The players layer never shows more than who may see who is online, whatever it is set to.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Saved; answers the new state",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustVisibility"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "An audience that does not exist"
|
||
},
|
||
"404": {
|
||
"description": "A server that does not exist"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustVisibilityUpdate"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/voice": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "The voice announcements are said in",
|
||
"description": "The permission group whose BetterChat style news and `rust.announce` lines are said in, or empty for plain chat, and every group that could be one. The line is composed on the site and said by the bridge plugin with no player as its sender, so it works whether or not BetterChat is loaded.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The voice and the groups that could be one",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustVoice"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
},
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Choose the voice announcements are said in",
|
||
"description": "`group` is a permission group with a chat style, or empty for plain chat. A group without a style is refused.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Saved; answers the new state",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustVoice"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "That group has no chat style"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"group": {
|
||
"type": "string",
|
||
"example": "staff"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/zones": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Zone presets, and what each server said about its zone mods",
|
||
"description": "Everything the zone presets page draws. Each server with what its last hello said about ZoneManager (its version and flag list, D211) and ZoneDomes (loaded, version, the domes helper’s state, and whether a dome may be added now, D194); every server’s flags, grouped as the form draws them (a flag the module does not know is under Other); the settings a zone may carry, with their bounds; and every preset, with `line` — the text a zone step copies when the preset is picked (D210). Read from the stored hello, so it answers while a server is off.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The page",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustZones"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/zones/presets": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Save a new zone preset",
|
||
"description": "A named set of ZoneManager flags and settings for the servers it lists, or for every server (`allServers`). Every flag must be on each listed server that has reported its flags, and is saved as that ZoneManager spells it. Two presets of one name may not share a server; the same name on different servers is allowed (D189). No preset ships with the module (D195).",
|
||
"responses": {
|
||
"201": {
|
||
"description": "Saved",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustZonePreset"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "A flag or setting the servers do not have, or out of range"
|
||
},
|
||
"404": {
|
||
"description": "A server that does not exist"
|
||
},
|
||
"409": {
|
||
"description": "A preset of that name is already on one of the servers"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustZonePresetInput"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/rust/zones/presets/{id}": {
|
||
"put": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Change a zone preset",
|
||
"description": "Replaces the preset whole, under the same rules as saving a new one. A zone step already made from it keeps its own copy of the options (D210), so no published event changes.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Saved",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustZonePreset"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "A flag or setting the servers do not have, or out of range"
|
||
},
|
||
"404": {
|
||
"description": "No such preset, or a server that does not exist"
|
||
},
|
||
"409": {
|
||
"description": "A preset of that name is already on one of the servers"
|
||
}
|
||
},
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustZonePresetInput"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"Admin · Rust"
|
||
],
|
||
"summary": "Delete a zone preset",
|
||
"description": "Removes the preset from the zone step’s dropdown. Steps made from it keep their own copy of its options (D210).",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Deleted"
|
||
},
|
||
"404": {
|
||
"description": "No such preset"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/users/{id}/rust/links": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Users"
|
||
],
|
||
"summary": "A user’s linked Steam accounts and their Rust record (admin only)",
|
||
"description": "Every Steam account linked to this website user, with the display name the game last saw and, per server, all-time kills / deaths / playtime across every wipe. Fills the admin.users.detail extension slot.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
},
|
||
"description": "User id."
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Linked accounts",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustAdminLinkList"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/api/v1/admin/users/{id}/rust/links/{steamId}": {
|
||
"delete": {
|
||
"tags": [
|
||
"Admin · Users"
|
||
],
|
||
"summary": "Sever a user’s Steam link (admin only)",
|
||
"description": "Staff release a link on this user’s behalf. It is the counterweight to the site refusing to move a Steam id another account holds: a player who cannot reach that Steam account in game has no other way back. Recorded in the activity log.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
},
|
||
"description": "User id."
|
||
},
|
||
{
|
||
"name": "steamId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The Steam id to release."
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Unlinked",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"unlinked": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not linked to this user",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/api/v1/admin/users/{id}/rust/permissions": {
|
||
"get": {
|
||
"tags": [
|
||
"Admin · Users"
|
||
],
|
||
"summary": "A user’s Rust privileges (admin only)",
|
||
"description": "The groups this person is in, the permissions granted to them directly, and the Steam accounts those privileges actually reach. An empty `reaches` means they have linked nothing and hold them on paper only.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
},
|
||
"description": "User id."
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Their groups and grants",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustUserPermissions"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/api/v1/admin/users/{id}/rust/permissions/grants": {
|
||
"post": {
|
||
"tags": [
|
||
"Admin · Users"
|
||
],
|
||
"summary": "Grant a Rust permission to this user (admin only)",
|
||
"description": "Authored against the website account, so it reaches every Steam id they have linked — now and later. `scope` is a server id or `*` for the fleet. The push happens on the mirror’s next pass.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
},
|
||
"description": "User id."
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "They already held it"
|
||
},
|
||
"201": {
|
||
"description": "Granted"
|
||
},
|
||
"400": {
|
||
"description": "Invalid body, or a scope naming no configured server",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Error"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"permission": {
|
||
"example": "any"
|
||
},
|
||
"scope": {
|
||
"example": "any"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/users/{id}/rust/permissions/grants/{grantId}": {
|
||
"delete": {
|
||
"tags": [
|
||
"Admin · Users"
|
||
],
|
||
"summary": "Remove a Rust permission from this user (admin only)",
|
||
"description": "Scoped to this user as well as to the grant, so a wrong id on the URL removes nothing rather than somebody else’s privilege. The revoke reaches the game on the mirror’s next pass.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
},
|
||
"description": "User id."
|
||
},
|
||
{
|
||
"name": "grantId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
},
|
||
"description": "The grant to remove."
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Removed"
|
||
},
|
||
"404": {
|
||
"description": "No such grant for this user",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/api/v1/player/rust/link": {
|
||
"post": {
|
||
"tags": [
|
||
"Player · Rust"
|
||
],
|
||
"summary": "Link a Steam account with a one-time code from /link in game",
|
||
"description": "The player types /link in game, the plugin hands them a six-character code privately, and they enter it here within five minutes. The site asks each configured server in turn until one recognises the code. A Steam account already linked to a different website account is refused rather than moved — the way out is /unlink in game.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Linked",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustLinkResult"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Unknown or expired code",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "That Steam account is linked to another website account",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"429": {
|
||
"description": "Too many link attempts",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
},
|
||
"503": {
|
||
"description": "A server could not be reached — the code is still good",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Error"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"required": true,
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustLinkRequest"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/player/rust/links": {
|
||
"get": {
|
||
"tags": [
|
||
"Player · Rust"
|
||
],
|
||
"summary": "The Steam accounts the caller has linked",
|
||
"description": "Every Steam account linked to the signed-in user, newest first. A link is fleet-wide: it is keyed by Steam id, not by server, because a Steam account is one person across every server an operator runs.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Linked accounts",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustLinkList"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/api/v1/player/rust/links/{steamId}": {
|
||
"delete": {
|
||
"tags": [
|
||
"Player · Rust"
|
||
],
|
||
"summary": "Release a Steam account the caller has linked",
|
||
"description": "Removes the caller’s own link. Scoped to the caller in the statement, so a link belonging to somebody else answers the same 404 as one that does not exist.",
|
||
"parameters": [
|
||
{
|
||
"name": "steamId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The Steam id to release."
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Unlinked",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"unlinked": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not linked to the caller",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/api/v1/player/rust/permissions": {
|
||
"get": {
|
||
"tags": [
|
||
"Player · Rust"
|
||
],
|
||
"summary": "What the site has given the caller in game",
|
||
"description": "The groups and direct grants the site holds for the signed-in user, each resolved to the servers its scope reaches and marked with whether that server has it yet. Read-only: a grant a player could change would not be a grant. `live` is the pushed ledger rather than the authored row, so an entitlement that has not reached a game reads as waiting — which is also what an offline server, a permission no loaded plugin registered, and an account the store has never seen all look like from here.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "What the caller holds",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustPlayerPermissions"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"cookieAuth": []
|
||
},
|
||
{
|
||
"bearerAuth": []
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"/api/v1/player/rust/servers": {
|
||
"get": {
|
||
"tags": [
|
||
"Player · Rust"
|
||
],
|
||
"summary": "The Rust servers, for a signed-in player",
|
||
"description": "The same servers the public list carries, answered on the authenticated tier. It is the address a signed-in client calls, so that per-player detail can be added here without moving it. Requires a session.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The server list",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustServerList"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/clans/{externalId}": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "One Rust clan",
|
||
"description": "A clan and, when the viewer is inside the operator’s clan roster audience, its roster. The audience defaults to the clan’s own members (a website account linked to one of them) and staff. Below it the clan is still described and `roster.visible` is false with no names. The roster never carries a Steam id or a website account id. `externalId` is `<server>:<clan>:<created>`, the same identity the site’s Team pages use.",
|
||
"parameters": [
|
||
{
|
||
"name": "externalId",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The clan’s identity: server, clan id and creation time in epoch ms, joined by colons"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The clan",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustClan"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No such clan"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "Every Rust server this site follows",
|
||
"description": "The operator’s configured Rust servers and what each one last reported. Answers with `online: false` and `stale: true` rather than failing when a game server or its sidecar is unreachable — the site’s availability does not depend on the game’s.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "The server list",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustServerList"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "One Rust server",
|
||
"description": "The same shape the list answers with, for one server, and a `404` when there is no such server or an operator has disabled it. The detail page needs the difference: every other route under this path answers an empty list for an id that does not exist, because an unknown server genuinely has no events and nobody online.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The server"
|
||
},
|
||
"404": {
|
||
"description": "No such server, or it is disabled"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}/clans": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "The clans on one Rust server",
|
||
"description": "Every clan on the server’s clan board, best score first: name, colour, score and member count. Public, because none of it names a player. `board` says whether the list is current and complete — a server whose bridge cannot read its clans answers an empty list and the reason, and a server at the game’s 100-clan ceiling says `truncated`.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The clans",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustClanList"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}/events": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "Recent events on one Rust server",
|
||
"description": "The killfeed and everything else public that happened on a server, newest first. Narrow with `kind` (comma-separated) and `wipe`. Only publicly classified kinds are ever returned — moderation events, login attempts and anything carrying an IP address are stored but never served here. Kinds that name a player who was on the server (connects, respawns, deaths, chat, tallies) are served only to viewers inside the operator’s presence audience, which defaults to staff; `presenceHidden` says when they were withheld.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
},
|
||
{
|
||
"name": "kind",
|
||
"in": "query",
|
||
"required": false,
|
||
"description": "One kind, or several comma-separated",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "wipe",
|
||
"in": "query",
|
||
"required": false,
|
||
"description": "Restrict to one wipe id",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "limit",
|
||
"in": "query",
|
||
"required": false,
|
||
"description": "Rows to return, capped at 200",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Recent events, newest first"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}/leaderboard": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "The leaderboard for one Rust server",
|
||
"description": "Per-wipe when `wipe` is given, all-time otherwise. All-time is the per-wipe rows summed rather than a second set of counters, so a wipe splits a player’s history without ending it. `lastSeen` is withheld below the operator’s presence audience: a gather tally refreshes it every minute a player is on, so it would name who is online. Each row carries `titles`: the chat titles that player holds now, as `[{ text, color }]` in the order the game shows them, and an empty list for a player with none. Titles rank the CURRENT wipe whichever wipe the page asks for, and are set by the operator’s rules.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
},
|
||
{
|
||
"name": "wipe",
|
||
"in": "query",
|
||
"required": false,
|
||
"description": "Restrict to one wipe id",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"in": "query",
|
||
"required": false,
|
||
"description": "kills, deaths, npcKills or playtime",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"name": "limit",
|
||
"in": "query",
|
||
"required": false,
|
||
"description": "Rows to return, capped at 200",
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The leaderboard"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}/map": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "One Rust server’s map",
|
||
"description": "Where the picture of the current map is, the geometry to draw it with (world size, the picture’s size and ocean margin in pixels, and the game’s own grid), the monuments when the viewer may see the world layer, and which of the four layers — `world`, `events`, `players`, `bases` — this viewer gets. A hidden layer says which audience can see it and never what it holds. The players layer can never be wider than who may see who is online (`cappedByPresence`). `mates` says whether this viewer gets their own position and their online clan mates’. `picture` is null when the game has no picture of its map; `geometry` is null when the server has never described its map.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The map, as this viewer may see it",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustMap"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No such server, or it is disabled"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}/map/image": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "The picture of one Rust server’s map",
|
||
"description": "The JPEG, cached as immutable for a year because the picture’s SHA-256 is in the URL. A hash that is not the stored picture’s answers 404, so a replaced picture is never served under an old address. Public at every setting: the picture is rendered from the map seed and says nothing about who plays.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
},
|
||
{
|
||
"name": "v",
|
||
"in": "query",
|
||
"required": true,
|
||
"description": "The picture’s SHA-256, as the map route names it",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The picture",
|
||
"content": {
|
||
"image/jpeg": {
|
||
"schema": {
|
||
"type": "string",
|
||
"format": "binary"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No such server, or no picture with that hash"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}/map/live": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "What moves on one Rust server’s map",
|
||
"description": "The positions this viewer may see, asked of the game while somebody is looking and held for five seconds, so any number of viewers cost one ask. **A layer the viewer may not see is absent from the answer**, not empty: `world` (world events and locked crates), `events` (what the site’s events placed), `players` (online players and sleepers, with names) and `bases` (tool cupboards and vending machines, positions only). `mates` is the viewer’s own position and their online first-party clan mates’, for a linked viewer when the server allows it. `live: false` with a `reason` when the game did not answer. Positions are never stored.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The positions this viewer may see",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustMapLive"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No such server, or it is disabled"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}/online": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "Who is on one Rust server right now",
|
||
"description": "Read from the presence board the bridge re-sends on every connect and every minute, rather than counted from connect and disconnect events — so it is correct even after the website has missed one. **Nothing names who is online by default**: below the operator’s presence audience (staff unless widened) the names are withheld and only `count` is answered.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Who is online — or, below the operator’s presence audience, only how many",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/RustOnline"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/public/rust/servers/{id}/wipes": {
|
||
"get": {
|
||
"tags": [
|
||
"Public · Rust"
|
||
],
|
||
"summary": "Every wipe this server has had",
|
||
"description": "Newest first. A wipe id is derived by the bridge plugin from the save’s creation time and stamped on every frame, so it is the same id the events and the leaderboard are filtered by.",
|
||
"parameters": [
|
||
{
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"description": "The server’s slug"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The wipes"
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
{
|
||
"name": "Public · Rust",
|
||
"description": "The Rust servers this site follows, as each one last reported itself"
|
||
},
|
||
{
|
||
"name": "Player · Rust",
|
||
"description": "The Rust surface for a signed-in player"
|
||
},
|
||
{
|
||
"name": "Admin · Rust",
|
||
"description": "Configuring the Rust servers and their sidecars"
|
||
}
|
||
],
|
||
"components": {
|
||
"schemas": {
|
||
"RustServerList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Every Rust server this site follows (GET /public/rust/servers)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustServer"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustServer": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One Rust server, as it last reported itself."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"online": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"players": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 42
|
||
}
|
||
}
|
||
},
|
||
"maxPlayers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 100
|
||
}
|
||
}
|
||
},
|
||
"hostname": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Runic Gateway · Main"
|
||
}
|
||
}
|
||
},
|
||
"level": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Procedural Map"
|
||
}
|
||
}
|
||
},
|
||
"worldSize": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 4000
|
||
}
|
||
}
|
||
},
|
||
"seed": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 1234
|
||
}
|
||
}
|
||
},
|
||
"updatedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"stale": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Has nothing reported in longer than the freshness window? A stale row is reported offline."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"nextWipe": {
|
||
"$ref": "#/components/schemas/RustNextWipe"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustNextWipe": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "When the server wipes next, computed from the operator’s schedule on every read, or null when no schedule is set. `source` is `forced` (Facepunch’s monthly forced wipe, first Thursday 19:00 UK time), `rule` (the server’s own weekly or biweekly day) or `once` (a one-off date the operator set, which replaces any computed wipe before it). Absent from a module older than phase 16."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"at": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "2026-10-01T18:00:00.000Z"
|
||
}
|
||
}
|
||
},
|
||
"source": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"forced",
|
||
"rule",
|
||
"once"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "forced"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustWipeSchedule": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A server’s wipe schedule as the operator stored it — what they typed, not what it computes to. A past `onceAt` is still returned so the form can show it as past."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"rule": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"none",
|
||
"forced",
|
||
"weekly",
|
||
"biweekly"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "weekly"
|
||
}
|
||
}
|
||
},
|
||
"day": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "0 = Sunday … 6 = Saturday"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 4
|
||
}
|
||
}
|
||
},
|
||
"time": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "14:00"
|
||
}
|
||
}
|
||
},
|
||
"tz": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "America/Chicago"
|
||
}
|
||
}
|
||
},
|
||
"anchor": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {}
|
||
}
|
||
},
|
||
"onceAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustServerSave": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The body of PUT /admin/rust/servers/{id}. The wipe fields are written only when `wipeRule` is present."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"sidecarBaseUrl": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "http://10.0.0.5:8090"
|
||
}
|
||
}
|
||
},
|
||
"sidecarToken": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Write-only. Omit or send empty to keep the stored one."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": ""
|
||
}
|
||
}
|
||
},
|
||
"protocol": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 11
|
||
}
|
||
}
|
||
},
|
||
"enabled": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"sortOrder": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 0
|
||
}
|
||
}
|
||
},
|
||
"wipeRule": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"none",
|
||
"forced",
|
||
"weekly",
|
||
"biweekly"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "weekly"
|
||
}
|
||
}
|
||
},
|
||
"wipeDay": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 4
|
||
}
|
||
}
|
||
},
|
||
"wipeTime": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "14:00"
|
||
}
|
||
}
|
||
},
|
||
"wipeTz": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "America/Chicago"
|
||
}
|
||
}
|
||
},
|
||
"wipeAnchor": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {}
|
||
}
|
||
},
|
||
"wipeOnceAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustAdminServerList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The configured servers, with their sidecar settings (GET /admin/rust/servers)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustAdminServer"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustAdminServer": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One configured server. The sidecar token is never included — `hasToken` reports only whether one is stored."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"sidecarBaseUrl": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "http://10.0.0.5:8090"
|
||
}
|
||
}
|
||
},
|
||
"hasToken": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"protocol": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 1
|
||
}
|
||
}
|
||
},
|
||
"enabled": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"sortOrder": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 0
|
||
}
|
||
}
|
||
},
|
||
"reachable": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Did the sidecar answer on the last poll? Separate from `online`, which is about the game rather than the bridge."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"bootId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "boot-20260915T194502Z"
|
||
}
|
||
}
|
||
},
|
||
"sidecarProtocol": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 1
|
||
}
|
||
}
|
||
},
|
||
"zoneHelper": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The ZoneManager helper the game reported at hello (protocol 13, PLAN_FIXES D182). `patched` means ZoneManager counts a player already standing in a zone when it is created or restored. `missing`, `unsupported` or `no-zonemanager` mean it does not: the bridge scores its zones by position instead, and the flags ZoneManager applies miss that player. Null when the plugin reported none."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"state": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"patched",
|
||
"unsupported",
|
||
"missing",
|
||
"no-zonemanager"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "patched"
|
||
}
|
||
}
|
||
},
|
||
"version": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "0.1.0"
|
||
}
|
||
}
|
||
},
|
||
"reason": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "this ZoneManager (3.2.0) has no Zone.InitializeZone"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"online": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"players": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 42
|
||
}
|
||
}
|
||
},
|
||
"stale": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"nextWipe": {
|
||
"$ref": "#/components/schemas/RustNextWipe"
|
||
},
|
||
"schedule": {
|
||
"$ref": "#/components/schemas/RustWipeSchedule"
|
||
},
|
||
"titles": {
|
||
"$ref": "#/components/schemas/RustTitleSettings"
|
||
},
|
||
"titlePush": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What the last push of titles to this server found, since this site last started: how many players hold one and whether BetterChat was there to show them. Null before the first push."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 4
|
||
}
|
||
}
|
||
},
|
||
"betterChat": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"at": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustTitleSettings": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One server’s chat titles (phase 17, D135–D136): rules that rank the current wipe, in precedence order, and how many titles a player shows."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"mode": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"first",
|
||
"all",
|
||
"upto"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "`first` shows the first rule a player meets, `all` every one, `upto` at most `max`."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "first"
|
||
}
|
||
}
|
||
},
|
||
"max": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"minimum": {
|
||
"type": "number",
|
||
"example": 1
|
||
},
|
||
"maximum": {
|
||
"type": "number",
|
||
"example": 5
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 2
|
||
}
|
||
}
|
||
},
|
||
"rules": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"maxItems": {
|
||
"type": "number",
|
||
"example": 10
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"stat": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"kills",
|
||
"npckills",
|
||
"animalkills",
|
||
"bowkills",
|
||
"meleekills",
|
||
"bladekills",
|
||
"revolverkills",
|
||
"headshots",
|
||
"pvpdistance",
|
||
"pvedistance",
|
||
"apckills",
|
||
"helikills",
|
||
"wood",
|
||
"ore",
|
||
"plants",
|
||
"attire",
|
||
"weapons",
|
||
"built",
|
||
"repaired",
|
||
"healed",
|
||
"rockets",
|
||
"explosives",
|
||
"missions",
|
||
"playtime"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The category the rule ranks (PLAN_REDESIGNS §5). `npckills` is human NPCs only (D209); `pvpdistance` and `pvedistance` rank the longest single kill; `playtime` has no default title."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kills"
|
||
}
|
||
}
|
||
},
|
||
"topN": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"minimum": {
|
||
"type": "number",
|
||
"example": 1
|
||
},
|
||
"maximum": {
|
||
"type": "number",
|
||
"example": 10
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 1
|
||
}
|
||
}
|
||
},
|
||
"text": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"maxLength": {
|
||
"type": "number",
|
||
"example": 24
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The title. `[`, `]`, `<`, `>`, `{` and `}` are taken out on save, so a title carries no markup of its own. Empty means the category’s title (D175), except for `playtime`."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Top Killer"
|
||
}
|
||
}
|
||
},
|
||
"color": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "#ff8800"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustTitleCategory": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One chat-title category (PLAN_REDESIGNS §5.5, D175) and the title a rule of it shows when the rule has none of its own."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"stat": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "animalkills"
|
||
}
|
||
}
|
||
},
|
||
"label": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Animal kills"
|
||
}
|
||
}
|
||
},
|
||
"default": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The module’s shipped title."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Beastbane"
|
||
}
|
||
}
|
||
},
|
||
"text": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The admin’s own title for the whole site, or null."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Hunter"
|
||
}
|
||
}
|
||
},
|
||
"current": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What shows: `text` when set, else `default`."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Hunter"
|
||
}
|
||
}
|
||
},
|
||
"updatedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustIntegrations": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Which optional mods a server has loaded right now (GET /admin/rust/servers/{id}/integrations), read live from the game."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"ok": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The sidecar client’s one-word status when the game could not be asked."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "ok"
|
||
}
|
||
}
|
||
},
|
||
"integrations": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Null when the game could not be asked, or its plugin is older than protocol 12."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"betterChat": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"loaded": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"version": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "5.2.15"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"popupNotifications": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"loaded": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustVoice": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The voice news and `rust.announce` lines are said in (D140): a styled permission group, or none for plain chat."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"voice": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A group name, or empty for plain chat."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "staff"
|
||
}
|
||
}
|
||
},
|
||
"options": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Every group that has a chat style — the only groups that can be a voice."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"group": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "staff"
|
||
}
|
||
}
|
||
},
|
||
"title": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "[Staff]"
|
||
}
|
||
}
|
||
},
|
||
"format": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The line the voice makes, with `{message}` where the words go."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "[#55aaff][+15][Staff][/+][/#] [#ffffff][+15]{message}[/+][/#]"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustLink": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One Steam account linked to a website user. Never carries a code."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"steamId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What the player was called in game when they linked. A display name only — a Rust name changes on a whim and nothing identifies anybody by it."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Wanderer"
|
||
}
|
||
}
|
||
},
|
||
"serverId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Which server minted the code. Not part of the identity — a link is fleet-wide — but it is where a support conversation starts."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"linkedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustLinkList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The Steam accounts one website user holds (GET /player/rust/links)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"links": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustLink"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPlayerReach": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One server an entitlement’s scope reaches, and whether it is there yet."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla+"
|
||
}
|
||
}
|
||
},
|
||
"live": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "True only when a sync confirmed this into that server’s own store. False covers every way it has not arrived — the server is offline, no loaded plugin registered the name, or its store has never seen the account — and the difference between those is an operator’s diagnosis, not a player’s."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPlayerPermissions": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What the site has given the signed-in player in game (GET /player/rust/permissions)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"accounts": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "How many Steam accounts the caller has linked. Zero is why an entitlement can be authored and reach nobody."
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 1
|
||
}
|
||
}
|
||
},
|
||
"groups": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "vip"
|
||
}
|
||
}
|
||
},
|
||
"title": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "VIP"
|
||
}
|
||
}
|
||
},
|
||
"scope": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A server id, or `*` for the whole fleet."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "*"
|
||
}
|
||
}
|
||
},
|
||
"since": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
}
|
||
}
|
||
},
|
||
"permissions": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"example": [
|
||
"kits.vip"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"reach": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustPlayerReach"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"grants": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"permission": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kits.vip"
|
||
}
|
||
}
|
||
},
|
||
"scope": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "*"
|
||
}
|
||
}
|
||
},
|
||
"source": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Who authored it — `admin` now, an event action later."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "admin"
|
||
}
|
||
}
|
||
},
|
||
"note": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"since": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
}
|
||
}
|
||
},
|
||
"reach": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustPlayerReach"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustLinkRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"required": {
|
||
"type": "array",
|
||
"example": [
|
||
"code"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The six-character code /link handed the player in game. Good for five minutes, and it works once."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "K7M2PQ"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustLinkResult": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The result of redeeming a code."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"linked": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"link": {
|
||
"$ref": "#/components/schemas/RustLink"
|
||
},
|
||
"already": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "True when this Steam id was already linked to the caller — a second press of the button, not an error."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustAdminLinkList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One user’s Rust identity, for the admin.users.detail panel (GET /admin/users/{id}/rust/links)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"links": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"steamId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What the game last saw this player called, falling back to the name recorded at link time."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Wanderer"
|
||
}
|
||
}
|
||
},
|
||
"linkedName": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Wanderer"
|
||
}
|
||
}
|
||
},
|
||
"serverId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"linkedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
}
|
||
}
|
||
},
|
||
"firstSeen": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"lastSeen": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "All-time totals per server, summed across every wipe."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"serverId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"serverName": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"kills": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 41
|
||
}
|
||
}
|
||
},
|
||
"deaths": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 37
|
||
}
|
||
}
|
||
},
|
||
"npcKills": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 120
|
||
}
|
||
}
|
||
},
|
||
"structures": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 64
|
||
}
|
||
}
|
||
},
|
||
"playtimeSec": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 43200
|
||
}
|
||
}
|
||
},
|
||
"wipes": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 2
|
||
}
|
||
}
|
||
},
|
||
"lastSeen": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPermissionOverview": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The permission manager’s front page (GET /admin/rust/permissions): every server with its policy and sync state, and every change made in a game that waits for a person (PLAN_REDESIGNS §1)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "rust-oxide"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Oxide rig"
|
||
}
|
||
}
|
||
},
|
||
"policy": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"auto-adopt",
|
||
"adopt",
|
||
"revoke"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What a change made in the game becomes (D161): the site’s own, a question for a person, or undone."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "auto-adopt"
|
||
}
|
||
}
|
||
},
|
||
"sync": {
|
||
"$ref": "#/components/schemas/RustPermissionSyncState"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"drift": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustPermissionDrift"
|
||
}
|
||
}
|
||
},
|
||
"policies": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"example": [
|
||
"auto-adopt",
|
||
"adopt",
|
||
"revoke"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"chatFields": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The twelve BetterChat group fields a style carries, with each one’s type and BetterChat’s default, for the style editor."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "TitleColor"
|
||
}
|
||
}
|
||
},
|
||
"type": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"int",
|
||
"title",
|
||
"color",
|
||
"size",
|
||
"bool",
|
||
"format"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "color"
|
||
}
|
||
}
|
||
},
|
||
"default": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "#55aaff"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPermissionDrift": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A change made in a game that waits for a person: every change under the `adopt` policy, an event’s grant removed in the game, a hand-edited style field, or a notice that a shared group was split (D190)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 3
|
||
}
|
||
}
|
||
},
|
||
"serverId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "rust-oxide"
|
||
}
|
||
}
|
||
},
|
||
"kind": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "`grant`, `member`, `group-permission`, `group`, or `chat-field`."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "grant"
|
||
}
|
||
}
|
||
},
|
||
"direction": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"added",
|
||
"removed",
|
||
"changed",
|
||
"split"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "added"
|
||
}
|
||
}
|
||
},
|
||
"subject": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A Steam id, or a group name."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000"
|
||
}
|
||
}
|
||
},
|
||
"object": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A permission or group name, a style field, or empty."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kits.vip"
|
||
}
|
||
}
|
||
},
|
||
"detail": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What the game holds now (a style value, a group’s title, rank and parent), or a notice’s sentence."
|
||
},
|
||
"example": {}
|
||
}
|
||
},
|
||
"username": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "wanderer"
|
||
}
|
||
}
|
||
},
|
||
"playerName": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Wanderer"
|
||
}
|
||
}
|
||
},
|
||
"firstSeen": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPermissionServer": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One server as the permission screen shows it (GET /admin/rust/permissions/servers/{serverId}), following uMod PermissionsManager’s flow (D162): plugins grouped by the plugin that registered each permission, the groups on the server (D189), every player holding anything there named by account and in-game name (D163), and the facts each toggle’s state is read from."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"server": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"policy": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "auto-adopt"
|
||
}
|
||
}
|
||
},
|
||
"sync": {
|
||
"$ref": "#/components/schemas/RustPermissionSyncState"
|
||
},
|
||
"plugins": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"key": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "plugin:ZoneManager"
|
||
}
|
||
}
|
||
},
|
||
"label": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "ZoneManager"
|
||
}
|
||
}
|
||
},
|
||
"registered": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "False for a name no plugin owns (Carbon’s built-in modules), grouped by its prefix."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"permissions": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "zonemanager.ignoreflag.nokits"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"groups": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 12
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "vip"
|
||
}
|
||
}
|
||
},
|
||
"title": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "VIP"
|
||
}
|
||
}
|
||
},
|
||
"rank": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 10
|
||
}
|
||
}
|
||
},
|
||
"parent": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "default"
|
||
}
|
||
}
|
||
},
|
||
"source": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "imported"
|
||
}
|
||
}
|
||
},
|
||
"builtin": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"allServers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"shared": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "On more than one server; a change to it asks whether to change it everywhere or split this server off."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "rust-oxide"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"permissions": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kits.vip"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"members": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"userId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
}
|
||
}
|
||
},
|
||
"username": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"steamIds": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"steamMembers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"chat": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"additionalProperties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"players": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"steamId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Wanderer"
|
||
}
|
||
}
|
||
},
|
||
"account": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"userId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
}
|
||
}
|
||
},
|
||
"username": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"grants": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"permission": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kits.vip"
|
||
}
|
||
}
|
||
},
|
||
"sources": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What puts it there: `userGrant`, `steamGrant` or `runGrant`, with its id and scope."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"groups": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "vip"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"excepted": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Grants that reach every server but this one (D190)."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"landed": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What has landed on this server: `grant <steamId> <permission>` and `member <steamId> <group>`."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"report": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"unresolved": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"pending": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"notLanded": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"drift": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustPermissionDrift"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPermissionSyncState": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Whether one server’s store matches what the site authors, and what its last report said."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"serverId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"state": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One of `pending`, `ok`, `failed`."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "ok"
|
||
}
|
||
}
|
||
},
|
||
"inSync": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "True when the last successful push carried the set the site currently authors."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"dirty": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"lastAttemptAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"lastOkAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"importedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "When this server’s store was first imported (D198). Null until then; until then every sync imports."
|
||
}
|
||
}
|
||
},
|
||
"error": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Why the last attempt failed — a transport word (`timeout`, `no-token`, `protocol-mismatch`) or the game’s own refusal."
|
||
},
|
||
"example": {}
|
||
}
|
||
},
|
||
"report": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The plugin’s report from the last successful sync."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"applied": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"grants": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 2
|
||
}
|
||
}
|
||
},
|
||
"revokes": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 0
|
||
}
|
||
}
|
||
},
|
||
"groupsCreated": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 1
|
||
}
|
||
}
|
||
},
|
||
"members": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 3
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"alreadyCorrect": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 14
|
||
}
|
||
}
|
||
},
|
||
"unresolved": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Permission names no loaded plugin on that server has registered. A grant naming one lands nowhere and is not recorded as pushed."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kits.gold"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"pending": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Memberships waiting on a first connection: the store has no user record to put in a group yet."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000:vip"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPermissionCatalogue": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Every permission name the configured servers have registered (GET /admin/rust/permissions/catalogue)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"permissions": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustPermissionCatalogueEntry"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPermissionCatalogueEntry": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One registered permission name, and which servers know it."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"permission": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kits.vip"
|
||
}
|
||
}
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"owner": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The plugin that registered it, from the inventory (PLAN_REDESIGNS §0.1)."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Kits"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustPermissionSyncResult": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What a forced sync produced (POST /admin/rust/permissions/sync)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustPermissionSyncState"
|
||
}
|
||
}
|
||
},
|
||
"drift": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustPermissionDrift"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustUserPermissions": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One person’s Rust privileges, for the admin.users.detail panel (GET /admin/users/{id}/rust/permissions)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"groups": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "vip"
|
||
}
|
||
}
|
||
},
|
||
"title": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "VIP"
|
||
}
|
||
}
|
||
},
|
||
"scope": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "*"
|
||
}
|
||
}
|
||
},
|
||
"permissions": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kits.vip"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"grants": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 7
|
||
}
|
||
}
|
||
},
|
||
"permission": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "kits.gold"
|
||
}
|
||
}
|
||
},
|
||
"scope": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"source": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "admin"
|
||
}
|
||
}
|
||
},
|
||
"grantedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"reaches": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The Steam accounts these privileges reach. Empty means this person has linked nothing and holds them on paper only."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustOnline": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Who is on one server (GET /public/rust/servers/{id}/online). Below the operator’s presence audience the names are withheld and only the count is answered — nothing names who is online by default."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"players": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Empty whenever `hidden` is true."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"steamId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Wanderer"
|
||
}
|
||
}
|
||
},
|
||
"sleeping": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"connectedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"hidden": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Were the names withheld from this viewer?"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"count": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "How many are online. Public at every audience."
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 12
|
||
}
|
||
}
|
||
},
|
||
"audience": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustAudience": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"staff",
|
||
"signed_in",
|
||
"public"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Who may see something: admins and moderators, any signed-in account, or anybody. Ordered — each includes the ones before it."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "staff"
|
||
}
|
||
}
|
||
},
|
||
"RustVisibility": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Who may see who is online: the fleet default and each server’s optional override (GET /admin/rust/visibility)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audiences": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
}
|
||
}
|
||
},
|
||
"presence": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"fleet": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"enabled": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"override": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"staff",
|
||
"signed_in",
|
||
"public",
|
||
null
|
||
],
|
||
"items": {}
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "This server’s own choice, or null to follow the fleet default."
|
||
}
|
||
}
|
||
},
|
||
"effective": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"clans": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Who may see a clan roster, and each server’s clan board."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audiences": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustClanAudience"
|
||
}
|
||
}
|
||
},
|
||
"roster": {
|
||
"$ref": "#/components/schemas/RustClanAudience"
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"supported": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"enabled": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"fresh": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"truncated": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"reason": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"clans": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 14
|
||
}
|
||
}
|
||
},
|
||
"umodClans": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Is the uMod Clans plugin loaded? Its clans are a separate system and are not Teams."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"map": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The live map’s switches and each server’s picture (phase 14)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"layers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"example": [
|
||
"world",
|
||
"events",
|
||
"players",
|
||
"bases"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"fleet": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"world": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
},
|
||
"events": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
},
|
||
"players": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
},
|
||
"bases": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
},
|
||
"mates": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"overrides": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Each layer and `mates`, or null to follow the fleet."
|
||
}
|
||
}
|
||
},
|
||
"effective": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
}
|
||
}
|
||
},
|
||
"picture": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"source": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"companion",
|
||
"rendered",
|
||
"none"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"mapKey": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"hasPicture": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"bytes": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
}
|
||
}
|
||
},
|
||
"worldSize": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
}
|
||
}
|
||
},
|
||
"fetchedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"renderStallSeconds": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "About how long Render now would stall this server."
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 9
|
||
}
|
||
}
|
||
},
|
||
"fetching": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"rendering": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"lastError": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"news": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Whether a published news post is also said in each server’s in-game chat. Off by default (D104)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"enabled": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"on": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"delivery": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"chat",
|
||
"popup"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Where the post goes when `on`: chat, or a popup — which needs PopupNotifications on that server (D142)."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "chat"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustMapLayer": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Whether this viewer gets one map layer, and which audience does. A hidden layer never says what it holds."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"visible": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"audience": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
},
|
||
"cappedByPresence": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Players layer only: narrower than its own switch because who may see who is online is narrower (D113)."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustMap": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One server’s map, as this viewer may see it (GET /public/rust/servers/{id}/map)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"serverId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"mapKey": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "3000.1234.1"
|
||
}
|
||
}
|
||
},
|
||
"picture": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Null when the game has no picture of its map."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"path": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Relative to /api/v1, with the picture’s hash in it."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "/public/rust/servers/main/map/image?v=28da6e8a"
|
||
}
|
||
}
|
||
},
|
||
"source": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"companion",
|
||
"rendered"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "companion"
|
||
}
|
||
}
|
||
},
|
||
"fetchedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"geometry": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "How world coordinates reach a pixel: s = (width − 2 × oceanMargin) / worldSize, px = (x + worldSize/2) × s + oceanMargin, and z the same way up from the bottom edge."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"worldSize": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 3000
|
||
}
|
||
}
|
||
},
|
||
"oceanMargin": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "In pixels, unscaled."
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 500
|
||
}
|
||
}
|
||
},
|
||
"width": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 2500
|
||
}
|
||
}
|
||
},
|
||
"height": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 2500
|
||
}
|
||
}
|
||
},
|
||
"gridCells": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Cells per side, from the game’s own grid."
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 20
|
||
}
|
||
}
|
||
},
|
||
"gridCellSize": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Metres."
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 150
|
||
}
|
||
}
|
||
},
|
||
"background": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "#0B3B4A"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"monuments": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Present only when the viewer may see the world layer."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"value": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "harbor_1#2"
|
||
}
|
||
}
|
||
},
|
||
"kind": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "harbor_1"
|
||
}
|
||
}
|
||
},
|
||
"label": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Harbor"
|
||
}
|
||
}
|
||
},
|
||
"grid": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "O3"
|
||
}
|
||
}
|
||
},
|
||
"x": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 678.1
|
||
}
|
||
}
|
||
},
|
||
"z": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 1005.7
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"layers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"world": {
|
||
"$ref": "#/components/schemas/RustMapLayer"
|
||
},
|
||
"events": {
|
||
"$ref": "#/components/schemas/RustMapLayer"
|
||
},
|
||
"players": {
|
||
"$ref": "#/components/schemas/RustMapLayer"
|
||
},
|
||
"bases": {
|
||
"$ref": "#/components/schemas/RustMapLayer"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"mates": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Whether this viewer gets their own position and their online clan mates’ (D115)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"visible": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"on": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Is the switch on for this server?"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"linked": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Has this viewer linked a Steam account?"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"signedIn": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Is this viewer signed in at all?"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"pollMs": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 10000
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustMapLive": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What moves on one server’s map, cut down to this viewer (GET /public/rust/servers/{id}/map/live). A layer the viewer may not see is ABSENT, not empty."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"live": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "False when the game did not answer; `reason` says why."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"reason": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"mapKey": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "3000.1234.1"
|
||
}
|
||
}
|
||
},
|
||
"world": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"kind": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"cargo",
|
||
"heli",
|
||
"chinook",
|
||
"bradley",
|
||
"supply",
|
||
"crate"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "cargo"
|
||
}
|
||
}
|
||
},
|
||
"x": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 812.4
|
||
}
|
||
}
|
||
},
|
||
"z": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": -1320.6
|
||
}
|
||
}
|
||
},
|
||
"hackLeftSec": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A locked crate being hacked: seconds left."
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 540
|
||
}
|
||
}
|
||
},
|
||
"hacked": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"events": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"kind": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"zone",
|
||
"crate",
|
||
"npc"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "zone"
|
||
}
|
||
}
|
||
},
|
||
"runId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "41"
|
||
}
|
||
}
|
||
},
|
||
"x": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
}
|
||
}
|
||
},
|
||
"z": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
}
|
||
}
|
||
},
|
||
"radius": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A zone’s."
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 60
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A zone’s."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Harbor brawl"
|
||
}
|
||
}
|
||
},
|
||
"prefab": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A crate’s or NPC’s allowlist key."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "crate.elite"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"players": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"steamId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "76561198000000000"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Wanderer"
|
||
}
|
||
}
|
||
},
|
||
"x": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
}
|
||
}
|
||
},
|
||
"z": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
}
|
||
}
|
||
},
|
||
"sleeping": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"online": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"playersTruncated": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "More sleepers than the plugin’s MapMaxSleepers."
|
||
}
|
||
}
|
||
},
|
||
"bases": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Positions only: no owner, no authorised list, no shop name."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"kind": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"tc",
|
||
"vending"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "tc"
|
||
}
|
||
}
|
||
},
|
||
"x": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
}
|
||
}
|
||
},
|
||
"z": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"basesTruncated": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "More than the plugin’s MapMaxBases."
|
||
}
|
||
}
|
||
},
|
||
"mates": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The viewer’s own positions (their sleeper too) and their online first-party clan mates on this server."
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"steamId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"x": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
}
|
||
}
|
||
},
|
||
"z": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "number"
|
||
}
|
||
}
|
||
},
|
||
"sleeping": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"online": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"self": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One of the viewer’s own accounts."
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustClanAudience": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"members",
|
||
"signed_in",
|
||
"public"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Who may see a clan’s roster: the clan’s own members (a website account linked to one of them) and staff, any signed-in account, or anybody. Widening it also shows which members are online to that audience."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "members"
|
||
}
|
||
}
|
||
},
|
||
"RustClanBoard": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Whether a server’s clan list can be trusted right now."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"supported": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Could the bridge read this server’s clans at all?"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"enabled": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Is the game’s clan system switched on?"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"fresh": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Has the board been re-sent within the last three minutes?"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"truncated": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "At the game’s 100-clan ceiling, or too large for one line: there may be clans the list does not show."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"reason": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Why the clans cannot be read, when they cannot."
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustClanList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One server’s clans (GET /public/rust/servers/{id}/clans). Public: nothing here names a player."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"clans": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"externalId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main:12:1790142840535"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Northwatch"
|
||
}
|
||
}
|
||
},
|
||
"color": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "#3fa9f5"
|
||
}
|
||
}
|
||
},
|
||
"score": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 140
|
||
}
|
||
}
|
||
},
|
||
"memberCount": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 6
|
||
}
|
||
}
|
||
},
|
||
"maxMembers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 100
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"board": {
|
||
"$ref": "#/components/schemas/RustClanBoard"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustClan": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "One clan (GET /public/rust/clans/{externalId}) and, inside the roster audience, its roster."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"clan": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"externalId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main:12:1790142840535"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Northwatch"
|
||
}
|
||
}
|
||
},
|
||
"color": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "#3fa9f5"
|
||
}
|
||
}
|
||
},
|
||
"score": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 140
|
||
}
|
||
}
|
||
},
|
||
"memberCount": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 6
|
||
}
|
||
}
|
||
},
|
||
"maxMembers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 100
|
||
}
|
||
}
|
||
},
|
||
"serverId": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"serverName": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"founded": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "When the clan was founded, epoch milliseconds."
|
||
}
|
||
}
|
||
},
|
||
"gone": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The clan has been disbanded, or has left its server’s board."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"roster": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"visible": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Is this viewer inside the roster audience? When false, `members` is empty."
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"audience": {
|
||
"$ref": "#/components/schemas/RustClanAudience"
|
||
},
|
||
"members": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Wanderer"
|
||
}
|
||
}
|
||
},
|
||
"role": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Leader"
|
||
}
|
||
}
|
||
},
|
||
"leader": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"online": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"joined": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Epoch milliseconds."
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustZonePreset": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A named set of ZoneManager flags and settings for one server, several, or every server (PLAN_REDESIGNS §3.1, D195). `line` is the text a zone step copies when the preset is picked (D210)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 3
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Arena"
|
||
}
|
||
}
|
||
},
|
||
"flags": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"example": [
|
||
"NoBuild",
|
||
"NoPlayerLoot"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"settings": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"additionalProperties": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "object",
|
||
"properties": {
|
||
"radiation": {
|
||
"type": "number",
|
||
"example": 10
|
||
},
|
||
"safezone": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"allServers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"example": [
|
||
"main"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"line": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "NoBuild, NoPlayerLoot, radiation=10, safezone=false"
|
||
}
|
||
}
|
||
},
|
||
"updatedAt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustZonePresetInput": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"required": {
|
||
"type": "array",
|
||
"example": [
|
||
"name"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A preset to save. `servers` is required unless `allServers` is true. Every flag must be on each covered server that has reported its ZoneManager flags; settings are radiation (0–500), comfort (0–1), temperature (−100–100), safezone (boolean) and permission (1–32 of a–z, 0–9, _)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Arena"
|
||
}
|
||
}
|
||
},
|
||
"flags": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"example": [
|
||
"NoBuild",
|
||
"NoPlayerLoot"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"settings": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"additionalProperties": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "object",
|
||
"properties": {
|
||
"radiation": {
|
||
"type": "number",
|
||
"example": 10
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"allServers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": false
|
||
}
|
||
}
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"example": [
|
||
"main"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustZones": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The zone presets page: each server with what its last hello said about ZoneManager (version, flags) and ZoneDomes (loaded, version, helper state, ready), every server’s flags grouped for the form, the settings a zone may carry, and the presets."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "main"
|
||
}
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "Main · Vanilla"
|
||
}
|
||
}
|
||
},
|
||
"enabled": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"zoneManager": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "object",
|
||
"properties": {
|
||
"version": {
|
||
"type": "string",
|
||
"example": "3.1.14"
|
||
},
|
||
"flagCount": {
|
||
"type": "number",
|
||
"example": 69
|
||
},
|
||
"flags": {
|
||
"type": "array",
|
||
"example": [
|
||
"NoBuild"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"zoneDomes": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"example": {
|
||
"type": "object",
|
||
"properties": {
|
||
"loaded": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"version": {
|
||
"type": "string",
|
||
"example": "2.0.2"
|
||
},
|
||
"helper": {
|
||
"type": "object",
|
||
"properties": {
|
||
"state": {
|
||
"type": "string",
|
||
"example": "patched"
|
||
},
|
||
"version": {
|
||
"type": "string",
|
||
"example": "0.1.0"
|
||
}
|
||
}
|
||
},
|
||
"ready": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"groups": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"group": {
|
||
"type": "string",
|
||
"example": "Building"
|
||
},
|
||
"flags": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string",
|
||
"example": "NoBuild"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"settings": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"key": {
|
||
"type": "string",
|
||
"example": "radiation"
|
||
},
|
||
"type": {
|
||
"type": "string",
|
||
"example": "float"
|
||
},
|
||
"min": {
|
||
"type": "number",
|
||
"example": 0
|
||
},
|
||
"max": {
|
||
"type": "number",
|
||
"example": 500
|
||
},
|
||
"label": {
|
||
"type": "string",
|
||
"example": "Radiation"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"presets": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "array"
|
||
},
|
||
"items": {
|
||
"$ref": "#/components/schemas/RustZonePreset"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustVisibilityUpdate": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A change to who may see who is online. Either part may be omitted; a server set to null follows the fleet default again."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"fleet": {
|
||
"$ref": "#/components/schemas/RustAudience"
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"additionalProperties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"staff",
|
||
"signed_in",
|
||
"public",
|
||
null
|
||
],
|
||
"items": {}
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "object",
|
||
"properties": {
|
||
"main": {
|
||
"type": "string",
|
||
"example": "public"
|
||
},
|
||
"pvp": {}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"clanRoster": {
|
||
"$ref": "#/components/schemas/RustClanAudience"
|
||
},
|
||
"news": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A server id to whether a published news post is said in its in-game chat."
|
||
},
|
||
"additionalProperties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "object",
|
||
"properties": {
|
||
"main": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"newsDelivery": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "A server id to where a news post goes on it: `chat` or `popup` (D142)."
|
||
},
|
||
"additionalProperties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"enum": {
|
||
"type": "array",
|
||
"example": [
|
||
"chat",
|
||
"popup"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"example": {
|
||
"type": "object",
|
||
"properties": {
|
||
"main": {
|
||
"type": "string",
|
||
"example": "popup"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"map": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The live map’s switches. `fleet` maps a layer to an audience and `mates` to true or false; `servers` maps a server id to the same shape, where null follows the fleet."
|
||
},
|
||
"example": {
|
||
"type": "object",
|
||
"properties": {
|
||
"fleet": {
|
||
"type": "object",
|
||
"properties": {
|
||
"players": {
|
||
"type": "string",
|
||
"example": "signed_in"
|
||
},
|
||
"mates": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"servers": {
|
||
"type": "object",
|
||
"properties": {
|
||
"pve": {
|
||
"type": "object",
|
||
"properties": {
|
||
"players": {
|
||
"type": "string",
|
||
"example": "public"
|
||
}
|
||
}
|
||
},
|
||
"pvp": {
|
||
"type": "object",
|
||
"properties": {
|
||
"players": {}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"RustSidecarProbe": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What a sidecar said when probed (POST /admin/rust/servers/{id}/test)."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"ok": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "What happened, in one word — this is what tells a wrong URL from a wrong token from a mismatched protocol. One of `ok`, `no-token`, `unauthorized`, `protocol-mismatch`, `timeout`, `transport-error`, or `http-<code>`."
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "ok"
|
||
}
|
||
}
|
||
},
|
||
"sidecar": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "object"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "The sidecar’s own health document, or the mismatch detail on a protocol disagreement."
|
||
},
|
||
"properties": {
|
||
"type": "object",
|
||
"properties": {
|
||
"status": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "ok"
|
||
}
|
||
}
|
||
},
|
||
"protocol": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "integer"
|
||
},
|
||
"example": {
|
||
"type": "number",
|
||
"example": 1
|
||
}
|
||
}
|
||
},
|
||
"plugin_connected": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "boolean"
|
||
},
|
||
"example": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
},
|
||
"database": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "ok"
|
||
}
|
||
}
|
||
},
|
||
"uptime": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"example": {
|
||
"type": "string",
|
||
"example": "3h 2m"
|
||
}
|
||
}
|
||
},
|
||
"last_event": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"example": "string"
|
||
},
|
||
"format": {
|
||
"type": "string",
|
||
"example": "date-time"
|
||
},
|
||
"nullable": {
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|