{ "paths": { "/api/v1/public/world/status": { "get": { "tags": [ "Public · Example Game" ], "summary": "The game world’s current status", "description": "What the game server last reported: whether it is up, how many players are on, and when that was. Answers with `online: false` and `stale: true` rather than failing when the game or its sidecar is unreachable — the site’s availability does not depend on the game’s.", "responses": { "200": { "description": "The world’s status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExamplegameWorldStatus" } } } }, "500": { "description": "Internal Server Error" } } } } }, "tags": [ { "name": "Public · Example Game", "description": "Live world data, as last reported by the game server" } ], "components": { "schemas": { "ExamplegameWorldStatus": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "description": { "type": "string", "example": "The game world’s status (GET /public/world/status)." }, "properties": { "type": "object", "properties": { "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": 12 } } }, "worldName": { "type": "object", "properties": { "type": { "type": "string", "example": "string" }, "nullable": { "type": "boolean", "example": true }, "example": { "type": "string", "example": "Example World" } } }, "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 } } } } } } } } } }