{ "openapi": "3.0.3", "info": { "title": "FNLB API documentation", "description": "FNLB API documentation", "version": "v1", "contact": { "name": "FNLB", "email": "support@fnlb.net", "url": "https://fnlb.net" }, "termsOfService": "https://fnlb.net/terms-of-service" }, "servers": [ { "url": "https://api.fnlb.net/v1", "description": "Production Instance" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "FNLB Token" } }, "schemas": {} }, "tags": [ { "name": "OAuth2", "description": "OAuth2 related endpoints" }, { "name": "User", "description": "User related endpoints" }, { "name": "Bots", "description": "Bot related endpoints" }, { "name": "Categories", "description": "Category related endpoints" }, { "name": "Commands", "description": "Command related endpoints" }, { "name": "Social", "description": "Friend and User related endpoints" }, { "name": "Public Bots", "description": "Public bot related endpoints" } ], "paths": { "/bots/{botId}/chat/messages/": { "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Commands" ], "summary": "Send Chat Message", "description": "Send a chat message to a specific bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "type": "object", "properties": { "content": { "minLength": 1, "maxLength": 255, "type": "string" }, "locale": { "type": "string", "enum": [ "en", "en-US", "es", "es-419", "ar", "de", "fr", "he", "id", "it", "ja", "ko", "pl", "pt", "pt-BR", "ru", "th", "tr", "vi", "zh", "zh-Hant" ] } }, "required": [ "content" ] } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "nonce": { "type": "string" }, "botName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string", "enum": [ 0, 1, 2, 3, 4 ] } }, "required": [ "nonce", "format" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "postBotsByBotIdChatMessages" } }, "/bots/{botId}/commands/run/": { "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Commands" ], "summary": "Run Command", "description": "Run a command on a specific bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "type": "object", "properties": { "command": { "minLength": 1, "maxLength": 255, "type": "string" }, "args": { "minLength": 1, "maxLength": 255, "type": "string" }, "locale": { "type": "string", "enum": [ "en", "en-US", "es", "es-419", "ar", "de", "fr", "he", "id", "it", "ja", "ko", "pl", "pt", "pt-BR", "ru", "th", "tr", "vi", "zh", "zh-Hant" ] } }, "required": [ "command" ] } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "nonce": { "type": "string" }, "botName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string", "enum": [ 0, 1, 2, 3, 4 ] } }, "required": [ "nonce", "format" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "postBotsByBotIdCommandsRun" } }, "/bots/{botId}/friends/pending/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Social" ], "summary": "Get Bot Pending Friends", "description": "Get all pending friend requests of a specific bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "incomingFriends": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id" ] } }, "outgoingFriends": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id" ] } } }, "required": [ "incomingFriends", "outgoingFriends" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBotsByBotIdFriendsPending" } }, "/bots/{botId}/friends/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Social" ], "summary": "Get Bot Friends", "description": "Get all friends of a specific bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "onlineFriends": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isJoinable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id" ] } }, "offlineFriends": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id" ] } } }, "required": [ "onlineFriends", "offlineFriends" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBotsByBotIdFriends" } }, "/bots/{botId}/users/blocked/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Social" ], "summary": "Get Bot Blocked Users", "description": "Get all blocked users of a specific bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id" ] } } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBotsByBotIdUsersBlocked" } }, "/bots/{botId}/users/search/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Social" ], "summary": "Search Users", "description": "Search for Epic Games users usign a bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } }, { "name": "prefix", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id" ] } } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBotsByBotIdUsersSearch" } }, "/bots/{botId}/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Bots" ], "summary": "Get a Bot", "description": "Get a specific bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "nickname": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "flags": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] } }, "required": [ "id", "nickname", "flags" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBotsByBotId" }, "patch": { "security": [ { "bearerAuth": [] } ], "tags": [ "Bots" ], "summary": "Update a Bot", "description": "Update a specific bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "type": "object", "properties": { "parent": { "anyOf": [ { "minLength": 1, "maxLength": 255, "type": "string" }, { "type": "null" } ] }, "nickname": { "minLength": 1, "maxLength": 16, "type": "string" }, "email": { "format": "email", "minLength": 1, "maxLength": 255, "type": "string" }, "disabled": { "type": "boolean" }, "deviceAuth": { "additionalProperties": false, "type": "object", "properties": { "accountId": { "minLength": 1, "maxLength": 255, "type": "string" }, "deviceId": { "minLength": 1, "maxLength": 255, "type": "string" }, "secret": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "accountId", "deviceId", "secret" ] } } } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "patchBotsByBotId" }, "delete": { "security": [ { "bearerAuth": [] } ], "tags": [ "Bots" ], "summary": "Delete a Bot", "description": "Delete a specific bot.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "deleteBotsByBotId" } }, "/bots/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Bots" ], "summary": "Get All Bots", "description": "Get all bots owned by the authenticated user.", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nickname": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "flags": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] } }, "required": [ "id", "nickname", "flags" ] } } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBots" }, "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Bots" ], "summary": "Create a Bot", "description": "Create a new bot.", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "type": "object", "properties": { "parent": { "minLength": 1, "maxLength": 255, "type": "string" }, "nickname": { "minLength": 1, "maxLength": 16, "type": "string" }, "email": { "format": "email", "minLength": 1, "maxLength": 255, "type": "string" }, "deviceAuth": { "additionalProperties": false, "type": "object", "properties": { "accountId": { "minLength": 1, "maxLength": 255, "type": "string" }, "deviceId": { "minLength": 1, "maxLength": 255, "type": "string" }, "secret": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "accountId", "deviceId", "secret" ] } }, "required": [ "nickname", "deviceAuth" ] } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created": { "type": "boolean" } }, "required": [ "id", "created" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "postBots" } }, "/bots/bulk-import/": { "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Bots" ], "summary": "Bulk Import Bots", "description": "Import multiple bots at once.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bots": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "accountId": { "minLength": 1, "maxLength": 255, "type": "string" }, "deviceId": { "minLength": 1, "maxLength": 255, "type": "string" }, "secret": { "minLength": 1, "maxLength": 255, "type": "string" }, "nickname": { "minLength": 1, "maxLength": 16, "type": "string" } }, "required": [ "accountId", "deviceId", "secret" ] } }, "parent": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "bots" ] } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "postBotsBulk-import" } }, "/bots/bulk-export/": { "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Bots" ], "summary": "Bulk Export Bots", "description": "Export all bots owned by the authenticated user.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "deleteAfterExport": { "type": "boolean" } }, "required": [ "deleteAfterExport" ] } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "deviceId": { "type": "string" }, "secret": { "type": "string" }, "nickname": { "type": "string" } }, "required": [ "accountId", "deviceId", "secret", "nickname" ] } } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "postBotsBulk-export" } }, "/bots/public/{botId}/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Public Bots" ], "summary": "Get a Public Bot", "description": "Get a specific public bot by its ID.", "parameters": [ { "name": "botId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBotsPublicByBotId" } }, "/bots/public/summary/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Public Bots" ], "summary": "Get Public Bots Summary", "description": "Get a summary of 3 public bots.", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBotsPublicSummary" } }, "/bots/public/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Public Bots" ], "summary": "Get All Public Bots", "description": "Get all public bots.", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getBotsPublic" } }, "/bots/stats/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Public Bots" ], "summary": "Get Bot Stats", "description": "Get global bot statistics.", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "public": { "type": "object", "properties": { "total": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "connected": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "available": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "busy": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "matches": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "availableBots": { "type": "array", "items": {} } }, "required": [ "total", "connected", "available", "busy", "matches", "availableBots" ] }, "vip": { "type": "object", "properties": { "total": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "connected": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "available": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "busy": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "matches": { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, "availableBots": { "type": "array", "items": {} } }, "required": [ "total", "connected", "available", "busy", "matches", "availableBots" ] } }, "required": [ "public", "vip" ] } } } } }, "operationId": "getBotsStats" } }, "/categories/{categoryId}/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Categories" ], "summary": "Get a Category", "description": "Get a specific category.", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "flags": { "anyOf": [ { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, { "type": "null" } ] }, "config": { "anyOf": [ { "additionalProperties": false, "type": "object", "properties": { "replyLangs": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "anyOf": [ { "const": "en", "type": "string" }, { "const": "en-US", "type": "string" }, { "const": "es", "type": "string" }, { "const": "es-419", "type": "string" }, { "const": "ar", "type": "string" }, { "const": "de", "type": "string" }, { "const": "fr", "type": "string" }, { "const": "he", "type": "string" }, { "const": "id", "type": "string" }, { "const": "it", "type": "string" }, { "const": "ja", "type": "string" }, { "const": "ko", "type": "string" }, { "const": "pl", "type": "string" }, { "const": "pt", "type": "string" }, { "const": "pt-BR", "type": "string" }, { "const": "ru", "type": "string" }, { "const": "th", "type": "string" }, { "const": "tr", "type": "string" }, { "const": "vi", "type": "string" }, { "const": "zh", "type": "string" }, { "const": "zh-Hant", "type": "string" } ] } }, "searchLangs": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "anyOf": [ { "const": "en", "type": "string" }, { "const": "en-US", "type": "string" }, { "const": "es", "type": "string" }, { "const": "es-419", "type": "string" }, { "const": "ar", "type": "string" }, { "const": "de", "type": "string" }, { "const": "fr", "type": "string" }, { "const": "he", "type": "string" }, { "const": "id", "type": "string" }, { "const": "it", "type": "string" }, { "const": "ja", "type": "string" }, { "const": "ko", "type": "string" }, { "const": "pl", "type": "string" }, { "const": "pt", "type": "string" }, { "const": "pt-BR", "type": "string" }, { "const": "ru", "type": "string" }, { "const": "th", "type": "string" }, { "const": "tr", "type": "string" }, { "const": "vi", "type": "string" }, { "const": "zh", "type": "string" }, { "const": "zh-Hant", "type": "string" } ] } }, "platform": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "anyOf": [ { "const": "WIN", "type": "string" }, { "const": "MAC", "type": "string" }, { "const": "PSN", "type": "string" }, { "const": "XBL", "type": "string" }, { "const": "SWT", "type": "string" }, { "const": "SWT2", "type": "string" }, { "const": "IOS", "type": "string" }, { "const": "AND", "type": "string" }, { "const": "PS5", "type": "string" }, { "const": "XSX", "type": "string" } ] } }, "privacy": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" } ] }, "prefixes": { "maxItems": 25, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "statusType": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" }, { "const": 2, "type": "number" } ] }, "statusText": { "maxItems": 25, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "statusInterval": { "minimum": 0, "maximum": 1024, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 1024, "type": "integer" } ] }, "level": { "maxItems": 10, "type": "array", "items": { "minimum": 0, "maximum": 999999999, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 999999999, "type": "integer" } ] } }, "bpLevel": { "maxItems": 10, "type": "array", "items": { "minimum": 0, "maximum": 999999999, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 999999999, "type": "integer" } ] } }, "extraOwners": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "admins": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "whitelistUsers": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "blacklistUsers": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "excludedAutoAddFriends": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "otherBots": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "inviteTimeout": { "minimum": 0, "maximum": 1024, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 1024, "type": "integer" } ] }, "maxBotsPerLobby": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithOwner": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithAdmin": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithWhitelistUser": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "allowMatchmaking": { "type": "boolean" }, "leaveAfterMatchmaking": { "type": "boolean" }, "disableMatchmakingChecks": { "type": "boolean" }, "disablePlaylistChecks": { "type": "boolean" }, "disableJoinMessages": { "type": "boolean" }, "disableAutomaticMessages": { "type": "boolean" }, "acceptFriendRequests": { "type": "boolean" }, "sendFriendRequestOnJoinParty": { "type": "boolean" }, "sendFriendRequestOnMemberJoinParty": { "type": "boolean" }, "runCommandsWithoutPrefix": { "type": "boolean" }, "setCosmeticsWithoutCommands": { "type": "boolean" }, "setCosmeticsWithPrefix": { "type": "boolean" }, "acceptInvites": { "type": "boolean" }, "startBannedBots": { "type": "boolean" }, "triggers": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "type": { "const": 0, "type": "number" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" }, "flags": { "minimum": 0, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "type": "integer" } ] }, "event": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" }, { "const": 2, "type": "number" }, { "const": 3, "type": "number" }, { "const": 4, "type": "number" }, { "const": 5, "type": "number" }, { "const": 6, "type": "number" }, { "const": 7, "type": "number" }, { "const": 8, "type": "number" }, { "const": 9, "type": "number" }, { "const": 10, "type": "number" }, { "const": 11, "type": "number" }, { "const": 12, "type": "number" }, { "const": 13, "type": "number" }, { "const": 14, "type": "number" }, { "const": 15, "type": "number" }, { "const": 16, "type": "number" }, { "const": 17, "type": "number" }, { "const": 18, "type": "number" }, { "const": 19, "type": "number" }, { "const": 20, "type": "number" }, { "const": 21, "type": "number" } ] }, "actions": { "maxItems": 25, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "type": { "const": 0, "type": "number" }, "command": { "minLength": 1, "maxLength": 255, "type": "string" }, "args": { "maxItems": 25, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } } }, "required": [ "type", "command" ] } } }, "required": [ "type", "name", "event", "actions" ] } }, "onlyOwnerCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyAdminCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyWhitelistUsersCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyFriendsCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyPartyMembersCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyWhisperCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "startOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "startBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinEmote": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinEmote": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } } } }, { "type": "null" } ] } }, "required": [ "id", "name" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getCategoriesByCategoryId" }, "patch": { "security": [ { "bearerAuth": [] } ], "tags": [ "Categories" ], "summary": "Update a Category", "description": "Update a specific category.", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "type": "object", "properties": { "name": { "minLength": 1, "maxLength": 255, "type": "string" }, "disabled": { "type": "boolean" }, "managed": { "type": "boolean" }, "config": { "additionalProperties": false, "type": "object", "properties": { "replyLangs": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "en", "en-US", "es", "es-419", "ar", "de", "fr", "he", "id", "it", "ja", "ko", "pl", "pt", "pt-BR", "ru", "th", "tr", "vi", "zh", "zh-Hant" ] } }, "searchLangs": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "en", "en-US", "es", "es-419", "ar", "de", "fr", "he", "id", "it", "ja", "ko", "pl", "pt", "pt-BR", "ru", "th", "tr", "vi", "zh", "zh-Hant" ] } }, "platform": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "WIN", "MAC", "PSN", "XBL", "SWT", "SWT2", "IOS", "AND", "PS5", "XSX" ] } }, "privacy": { "type": "string", "enum": [ 0, 1 ] }, "prefixes": { "maxItems": 25, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "statusType": { "type": "string", "enum": [ 0, 1, 2 ] }, "statusText": { "maxItems": 25, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "statusInterval": { "minimum": 0, "maximum": 1024, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 1024, "type": "integer" } ] }, "level": { "maxItems": 10, "type": "array", "items": { "minimum": 0, "maximum": 999999999, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 999999999, "type": "integer" } ] } }, "bpLevel": { "maxItems": 10, "type": "array", "items": { "minimum": 0, "maximum": 999999999, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 999999999, "type": "integer" } ] } }, "extraOwners": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "admins": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "whitelistUsers": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "blacklistUsers": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "excludedAutoAddFriends": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "otherBots": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "inviteTimeout": { "minimum": 0, "maximum": 1024, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 1024, "type": "integer" } ] }, "maxBotsPerLobby": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithOwner": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithAdmin": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithWhitelistUser": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "allowMatchmaking": { "type": "boolean" }, "leaveAfterMatchmaking": { "type": "boolean" }, "disableMatchmakingChecks": { "type": "boolean" }, "disablePlaylistChecks": { "type": "boolean" }, "disableJoinMessages": { "type": "boolean" }, "disableAutomaticMessages": { "type": "boolean" }, "acceptFriendRequests": { "type": "boolean" }, "sendFriendRequestOnJoinParty": { "type": "boolean" }, "sendFriendRequestOnMemberJoinParty": { "type": "boolean" }, "runCommandsWithoutPrefix": { "type": "boolean" }, "setCosmeticsWithoutCommands": { "type": "boolean" }, "setCosmeticsWithPrefix": { "type": "boolean" }, "acceptInvites": { "type": "boolean" }, "startBannedBots": { "type": "boolean" }, "triggers": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "type": { "const": 0, "type": "number" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" }, "flags": { "minimum": 0, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "type": "integer" } ] }, "event": { "type": "string", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 ] }, "actions": { "maxItems": 25, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "type": { "const": 0, "type": "number" }, "command": { "minLength": 1, "maxLength": 255, "type": "string" }, "args": { "maxItems": 25, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } } }, "required": [ "type", "command" ] } } }, "required": [ "type", "name", "event", "actions" ] } }, "onlyOwnerCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyAdminCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyWhitelistUsersCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyFriendsCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyPartyMembersCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyWhisperCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "startOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "startBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinEmote": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinEmote": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } } } } }, "required": [ "name" ] } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "patchCategoriesByCategoryId" }, "delete": { "security": [ { "bearerAuth": [] } ], "tags": [ "Categories" ], "summary": "Delete a Category", "description": "Delete a specific category.", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "minLength": 1, "maxLength": 255, "type": "string" } }, { "name": "includeBots", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "deleteCategoriesByCategoryId" } }, "/categories/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Categories" ], "summary": "Get All Categories", "description": "Get all categories owned by the authenticated user.", "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "flags": { "anyOf": [ { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, { "type": "null" } ] }, "config": { "anyOf": [ { "additionalProperties": false, "type": "object", "properties": { "replyLangs": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "anyOf": [ { "const": "en", "type": "string" }, { "const": "en-US", "type": "string" }, { "const": "es", "type": "string" }, { "const": "es-419", "type": "string" }, { "const": "ar", "type": "string" }, { "const": "de", "type": "string" }, { "const": "fr", "type": "string" }, { "const": "he", "type": "string" }, { "const": "id", "type": "string" }, { "const": "it", "type": "string" }, { "const": "ja", "type": "string" }, { "const": "ko", "type": "string" }, { "const": "pl", "type": "string" }, { "const": "pt", "type": "string" }, { "const": "pt-BR", "type": "string" }, { "const": "ru", "type": "string" }, { "const": "th", "type": "string" }, { "const": "tr", "type": "string" }, { "const": "vi", "type": "string" }, { "const": "zh", "type": "string" }, { "const": "zh-Hant", "type": "string" } ] } }, "searchLangs": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "anyOf": [ { "const": "en", "type": "string" }, { "const": "en-US", "type": "string" }, { "const": "es", "type": "string" }, { "const": "es-419", "type": "string" }, { "const": "ar", "type": "string" }, { "const": "de", "type": "string" }, { "const": "fr", "type": "string" }, { "const": "he", "type": "string" }, { "const": "id", "type": "string" }, { "const": "it", "type": "string" }, { "const": "ja", "type": "string" }, { "const": "ko", "type": "string" }, { "const": "pl", "type": "string" }, { "const": "pt", "type": "string" }, { "const": "pt-BR", "type": "string" }, { "const": "ru", "type": "string" }, { "const": "th", "type": "string" }, { "const": "tr", "type": "string" }, { "const": "vi", "type": "string" }, { "const": "zh", "type": "string" }, { "const": "zh-Hant", "type": "string" } ] } }, "platform": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "anyOf": [ { "const": "WIN", "type": "string" }, { "const": "MAC", "type": "string" }, { "const": "PSN", "type": "string" }, { "const": "XBL", "type": "string" }, { "const": "SWT", "type": "string" }, { "const": "SWT2", "type": "string" }, { "const": "IOS", "type": "string" }, { "const": "AND", "type": "string" }, { "const": "PS5", "type": "string" }, { "const": "XSX", "type": "string" } ] } }, "privacy": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" } ] }, "prefixes": { "maxItems": 25, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "statusType": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" }, { "const": 2, "type": "number" } ] }, "statusText": { "maxItems": 25, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "statusInterval": { "minimum": 0, "maximum": 1024, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 1024, "type": "integer" } ] }, "level": { "maxItems": 10, "type": "array", "items": { "minimum": 0, "maximum": 999999999, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 999999999, "type": "integer" } ] } }, "bpLevel": { "maxItems": 10, "type": "array", "items": { "minimum": 0, "maximum": 999999999, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 999999999, "type": "integer" } ] } }, "extraOwners": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "admins": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "whitelistUsers": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "blacklistUsers": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "excludedAutoAddFriends": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "otherBots": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "inviteTimeout": { "minimum": 0, "maximum": 1024, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 1024, "type": "integer" } ] }, "maxBotsPerLobby": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithOwner": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithAdmin": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithWhitelistUser": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "allowMatchmaking": { "type": "boolean" }, "leaveAfterMatchmaking": { "type": "boolean" }, "disableMatchmakingChecks": { "type": "boolean" }, "disablePlaylistChecks": { "type": "boolean" }, "disableJoinMessages": { "type": "boolean" }, "disableAutomaticMessages": { "type": "boolean" }, "acceptFriendRequests": { "type": "boolean" }, "sendFriendRequestOnJoinParty": { "type": "boolean" }, "sendFriendRequestOnMemberJoinParty": { "type": "boolean" }, "runCommandsWithoutPrefix": { "type": "boolean" }, "setCosmeticsWithoutCommands": { "type": "boolean" }, "setCosmeticsWithPrefix": { "type": "boolean" }, "acceptInvites": { "type": "boolean" }, "startBannedBots": { "type": "boolean" }, "triggers": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "type": { "const": 0, "type": "number" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" }, "flags": { "minimum": 0, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "type": "integer" } ] }, "event": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" }, { "const": 2, "type": "number" }, { "const": 3, "type": "number" }, { "const": 4, "type": "number" }, { "const": 5, "type": "number" }, { "const": 6, "type": "number" }, { "const": 7, "type": "number" }, { "const": 8, "type": "number" }, { "const": 9, "type": "number" }, { "const": 10, "type": "number" }, { "const": 11, "type": "number" }, { "const": 12, "type": "number" }, { "const": 13, "type": "number" }, { "const": 14, "type": "number" }, { "const": 15, "type": "number" }, { "const": 16, "type": "number" }, { "const": 17, "type": "number" }, { "const": 18, "type": "number" }, { "const": 19, "type": "number" }, { "const": 20, "type": "number" }, { "const": 21, "type": "number" } ] }, "actions": { "maxItems": 25, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "type": { "const": 0, "type": "number" }, "command": { "minLength": 1, "maxLength": 255, "type": "string" }, "args": { "maxItems": 25, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } } }, "required": [ "type", "command" ] } } }, "required": [ "type", "name", "event", "actions" ] } }, "onlyOwnerCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyAdminCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyWhitelistUsersCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyFriendsCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyPartyMembersCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyWhisperCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "startOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "startBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinEmote": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinEmote": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } } } }, { "type": "null" } ] } }, "required": [ "id", "name" ] } } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getCategories" }, "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Categories" ], "summary": "Create a Category", "description": "Create a new category.", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "type": "object", "properties": { "name": { "minLength": 1, "maxLength": 255, "type": "string" }, "disabled": { "type": "boolean" }, "config": { "additionalProperties": false, "type": "object", "properties": { "replyLangs": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "en", "en-US", "es", "es-419", "ar", "de", "fr", "he", "id", "it", "ja", "ko", "pl", "pt", "pt-BR", "ru", "th", "tr", "vi", "zh", "zh-Hant" ] } }, "searchLangs": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "en", "en-US", "es", "es-419", "ar", "de", "fr", "he", "id", "it", "ja", "ko", "pl", "pt", "pt-BR", "ru", "th", "tr", "vi", "zh", "zh-Hant" ] } }, "platform": { "maxItems": 10, "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "WIN", "MAC", "PSN", "XBL", "SWT", "SWT2", "IOS", "AND", "PS5", "XSX" ] } }, "privacy": { "type": "string", "enum": [ 0, 1 ] }, "prefixes": { "maxItems": 25, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "statusType": { "type": "string", "enum": [ 0, 1, 2 ] }, "statusText": { "maxItems": 25, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "statusInterval": { "minimum": 0, "maximum": 1024, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 1024, "type": "integer" } ] }, "level": { "maxItems": 10, "type": "array", "items": { "minimum": 0, "maximum": 999999999, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 999999999, "type": "integer" } ] } }, "bpLevel": { "maxItems": 10, "type": "array", "items": { "minimum": 0, "maximum": 999999999, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 999999999, "type": "integer" } ] } }, "extraOwners": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "admins": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "whitelistUsers": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "blacklistUsers": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "excludedAutoAddFriends": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "otherBots": { "maxItems": 1000, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 32, "type": "string" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ] } }, "inviteTimeout": { "minimum": 0, "maximum": 1024, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 1024, "type": "integer" } ] }, "maxBotsPerLobby": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithOwner": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithAdmin": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "maxBotsPerLobbyWithWhitelistUser": { "minimum": 0, "maximum": 16, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 16, "type": "integer" } ] }, "allowMatchmaking": { "type": "boolean" }, "leaveAfterMatchmaking": { "type": "boolean" }, "disableMatchmakingChecks": { "type": "boolean" }, "disablePlaylistChecks": { "type": "boolean" }, "disableJoinMessages": { "type": "boolean" }, "disableAutomaticMessages": { "type": "boolean" }, "acceptFriendRequests": { "type": "boolean" }, "sendFriendRequestOnJoinParty": { "type": "boolean" }, "sendFriendRequestOnMemberJoinParty": { "type": "boolean" }, "runCommandsWithoutPrefix": { "type": "boolean" }, "setCosmeticsWithoutCommands": { "type": "boolean" }, "setCosmeticsWithPrefix": { "type": "boolean" }, "acceptInvites": { "type": "boolean" }, "startBannedBots": { "type": "boolean" }, "triggers": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "type": { "const": 0, "type": "number" }, "name": { "minLength": 1, "maxLength": 255, "type": "string" }, "flags": { "minimum": 0, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "type": "integer" } ] }, "event": { "type": "string", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 ] }, "actions": { "maxItems": 25, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "type": { "const": 0, "type": "number" }, "command": { "minLength": 1, "maxLength": 255, "type": "string" }, "args": { "maxItems": 25, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } } }, "required": [ "type", "command" ] } } }, "required": [ "type", "name", "event", "actions" ] } }, "onlyOwnerCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyAdminCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyWhitelistUsersCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyFriendsCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyPartyMembersCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "onlyWhisperCommands": { "maxItems": 255, "uniqueItems": true, "type": "array", "items": { "minLength": 1, "maxLength": 255, "type": "string" } }, "startOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "startBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "startBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinEmote": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "joinBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "joinBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinOutfit": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinBackpack": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinPickaxe": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinEmote": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinShoes": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" }, "variants": { "maxItems": 255, "type": "array", "items": { "minimum": 0, "maximum": 255, "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "minimum": 0, "maximum": 255, "type": "integer" } ] } } }, "required": [ "id" ] } }, "memberJoinBanner": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } }, "memberJoinBannerColor": { "maxItems": 30, "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "id": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "id" ] } } } } }, "required": [ "name" ] } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "ok": { "type": "boolean" } }, "required": [ "id", "ok" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "postCategories" } }, "/oauth2/token": { "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "OAuth2" ], "summary": "Exchange Token", "description": "Exchange an authorization code for an access token.", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "grant_type": { "const": "authorization_code", "type": "string" }, "code": { "minLength": 1, "maxLength": 255, "type": "string" }, "redirect_uri": { "minLength": 1, "maxLength": 255, "type": "string" }, "client_id": { "minLength": 1, "maxLength": 32, "type": "string" }, "client_secret": { "minLength": 1, "maxLength": 255, "type": "string" } }, "required": [ "grant_type", "code", "redirect_uri", "client_id", "client_secret" ] } } }, "required": true }, "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "const": "Bearer", "type": "string" }, "scope": { "type": "string" } }, "required": [ "access_token", "token_type", "scope" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "postOauth2Token" } }, "/user/": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "User" ], "summary": "Get User Information", "description": "Requires the identify scope if using an OAuth2 application.", "parameters": [ { "name": "includeEmail", "in": "query", "required": false, "schema": { "description": "Whether to include the user's email. Requires the email scope if using an OAuth2 application.", "type": "boolean" } } ], "responses": { "200": { "description": "Response for status 200", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "flags": { "anyOf": [ { "anyOf": [ { "format": "integer", "default": 0, "type": "string" }, { "type": "integer" } ] }, { "type": "null" } ] }, "connections": { "type": "object", "properties": { "discord": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified": { "type": "boolean" } }, "required": [ "verified" ] }, { "type": "null" } ] }, "epic": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified": { "type": "boolean" } }, "required": [ "verified" ] }, { "type": "null" } ] } } } }, "required": [ "id", "username", "connections" ] } } } }, "400": { "description": "Response for status 400", "content": { "application/json": { "schema": {} } } } }, "operationId": "getUser" } } } }