{
  "paths": {
    "/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.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Saved"
          },
          "400": {
            "description": "Invalid body"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "example": "any"
                  },
                  "sidecarBaseUrl": {
                    "example": "any"
                  },
                  "sidecarToken": {
                    "example": "any"
                  },
                  "protocol": {
                    "example": "any"
                  },
                  "enabled": {
                    "example": "any"
                  },
                  "sortOrder": {
                    "example": "any"
                  }
                }
              }
            }
          }
        }
      },
      "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}/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/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/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"
          }
        }
      }
    }
  },
  "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
                  }
                }
              }
            }
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      },
      "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
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}