{ "openapi": "3.1.0", "info": { "title": "Cooldown MMO API (Alpha)", "version": "1.0.0", "description": "Cooldown MMO API \u2014 **Early Access (Alpha)** v1.0.0. Cooldown-based character actions over HTTP. Platform: [cooldownmmo.com](https:\/\/cooldownmmo.com).\n\n**Auth:** `Authorization: Bearer {token}` (Sanctum). Register\/login return plaintext tokens.\n\n**Actions:** `POST \/my\/{name}\/action\/...` \u2014 uses the account default app; optional `\/{appCode}\/\u2026` override exists for a second world. One action per character while cooldown active; response includes `cooldown` and updated `character`.\n\n**Reads:** `GET \/my\/{name}?view=play` for the map HUD; full sheet without `view=play`. Action responses embed inventory \u2014 avoid chaining `\/inventory` after every fight.\n\n**Content:** Barrens + Westfall overworlds, parties, dungeon-fight, quests, vendors, play-loop templates. Levels **1\u201340**.\n\n**Errors:** `{ \"error\": { \"code\", \"message\", \"details?\" } }`. Waitable **409** codes: `character_on_cooldown`, `content_on_cooldown`, `content_busy`. Lists: `{ \"data\", \"pagination\" }`.\n" }, "servers": [ { "url": "https:\/\/docs.cooldownmmo.com\/api" } ], "security": [ { "http": [] } ], "paths": { "\/achievements": { "get": { "operationId": "achievement.account", "summary": "Account-scoped achievement progress for the current membership", "tags": [ "Achievement" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": {} }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "membership_not_found" }, "message": { "type": "string", "const": "Join this world before playing." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/achievements": { "get": { "operationId": "achievement.character", "summary": "Character-scoped achievement progress", "tags": [ "Achievement" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": {} }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/auth\/register": { "post": { "operationId": "auth.register", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RegisterRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "user": { "type": "array", "items": {} }, "token": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "plain_text": { "type": "string" }, "abilities": { "type": "string" } }, "required": [ "id", "name", "plain_text", "abilities" ] } }, "required": [ "user", "token" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/auth\/login": { "post": { "operationId": "auth.login", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LoginRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "user": { "type": "array", "items": {} }, "token": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "plain_text": { "type": "string" }, "abilities": { "type": "string" } }, "required": [ "id", "name", "plain_text", "abilities" ] } }, "required": [ "user", "token" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/auth\/logout": { "post": { "operationId": "auth.logout", "tags": [ "Auth" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/logs": { "get": { "operationId": "character.accountLogs", "tags": [ "Character" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "action_type", "in": "query", "schema": { "type": "string", "enum": [ "move", "fight", "rest", "gather", "craft", "bank_deposit", "bank_withdraw", "dungeon_start", "dungeon_wave", "dungeon_rest", "dungeon_abandon" ] } }, { "name": "outcome", "in": "query", "schema": { "type": "string", "enum": [ "success", "failure" ] } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterActionResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/characters": { "get": { "operationId": "character.index", "tags": [ "Character" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterResource" } }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "character.store", "tags": [ "Character" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CreateCharacterRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}": { "get": { "operationId": "character.show", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterPlayResource" }, { "$ref": "#\/components\/schemas\/CharacterResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/inventory": { "get": { "operationId": "character.inventory", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "equipment": { "type": "array", "items": {} }, "inventory": { "type": "array", "items": {} }, "slots": { "type": "string" } }, "required": [ "equipment", "inventory", "slots" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/logs": { "get": { "operationId": "character.logs", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "action_type", "in": "query", "schema": { "type": "string", "enum": [ "move", "fight", "rest", "gather", "craft", "bank_deposit", "bank_withdraw", "dungeon_start", "dungeon_wave", "dungeon_rest", "dungeon_abandon" ] } }, { "name": "outcome", "in": "query", "schema": { "type": "string", "enum": [ "success", "failure" ] } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterActionResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/bank": { "get": { "operationId": "character.bank", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "gold": { "type": "integer" }, "items": { "type": "array", "items": {} }, "slots": { "type": "object", "properties": { "used": { "type": "integer", "minimum": 0 }, "capacity": { "type": "integer" }, "base": { "type": "integer", "const": 40 }, "purchased": { "type": "integer" }, "purchase_max": { "type": "integer", "const": 20 }, "next_cost": { "type": [ "integer", "null" ] } }, "required": [ "used", "capacity", "base", "purchased", "purchase_max", "next_cost" ] } }, "required": [ "gold", "items", "slots" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/active": { "patch": { "operationId": "character.setActive", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateCharacterActiveRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/move": { "post": { "operationId": "character.move", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MoveCharacterRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterActionResultResource" }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/fight": { "post": { "operationId": "character.fight", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FightBattleSettingsRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "fight": { "type": "string" }, "content_cooldown": { "type": [ "string", "null" ] } }, "required": [ "character", "fight", "content_cooldown" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/party-fight": { "post": { "operationId": "character.partyFight", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FightBattleSettingsRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "fight": { "type": "string" }, "characters": { "type": "array", "items": {} }, "content_cooldown": { "type": [ "string", "null" ] }, "encounter": { "type": [ "string", "null" ] } }, "required": [ "fight", "characters", "content_cooldown", "encounter" ] }, { "type": "string" } ] }, "cooldown": { "type": "string" }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/rest": { "post": { "operationId": "character.rest", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "healed": { "type": "string" } }, "required": [ "character", "healed" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/action\/use-consumable": { "post": { "operationId": "character.useConsumable", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UseConsumableRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "item": { "type": "string" }, "buffs": { "type": "string" } }, "required": [ "character", "item", "buffs" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/gather": { "post": { "operationId": "character.gather", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GatherResourceRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "gather": { "type": "string" }, "content_cooldown": { "type": "string" } }, "required": [ "character", "gather", "content_cooldown" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/skin": { "post": { "operationId": "character.skin", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "skin": { "type": "string" } }, "required": [ "character", "skin" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/action\/craft": { "post": { "operationId": "character.craft", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CraftItemRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "craft": { "type": "string" } }, "required": [ "character", "craft" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/bonfire": { "post": { "operationId": "character.placeBonfire", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "bonfire": { "type": "object", "properties": { "map": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" } }, "required": [ "id", "code" ] }, "x": { "type": "string" }, "y": { "type": "string" }, "moved": { "type": "string" }, "station": { "type": "string", "const": "bonfire" } }, "required": [ "map", "x", "y", "moved", "station" ] } }, "required": [ "character", "bonfire" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/action\/travel": { "post": { "operationId": "character.travel", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "travel": { "type": "string" } }, "required": [ "character", "travel" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/action\/equip": { "post": { "operationId": "character.equip", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EquipItemRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "equip": { "type": "string" } }, "required": [ "character", "equip" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/unequip": { "post": { "operationId": "character.unequip", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnequipItemRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "unequip": { "type": "string" } }, "required": [ "character", "unequip" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/destroy": { "post": { "operationId": "character.destroyItem", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DestroyItemRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "destroy": { "type": "string" } }, "required": [ "character", "destroy" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/dungeon-fight": { "post": { "operationId": "character.dungeonFight", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ClearDungeonRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "run": { "type": "array", "items": {} }, "waves": { "type": "string" }, "clean": { "type": "boolean" }, "characters": { "type": "array", "items": {} }, "content_cooldown": { "type": [ "string", "null" ] } }, "required": [ "run", "waves", "clean", "characters", "content_cooldown" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/bank\/deposit": { "post": { "operationId": "character.bankDeposit", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BankTransferRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "bank_gold": { "type": "string" }, "deposit": { "type": "string" } }, "required": [ "character", "bank_gold", "deposit" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/bank\/withdraw": { "post": { "operationId": "character.bankWithdraw", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BankTransferRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "bank_gold": { "type": "string" }, "withdraw": { "type": "string" } }, "required": [ "character", "bank_gold", "withdraw" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/bank\/purchase-slot": { "post": { "operationId": "character.bankPurchaseSlot", "tags": [ "Character" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "bank_gold": { "type": "string" }, "slots": { "type": "string" }, "purchase": { "type": "string" } }, "required": [ "character", "bank_gold", "slots", "purchase" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/actions\/{actionId}": { "get": { "operationId": "characterAction.show", "tags": [ "CharacterAction" ], "parameters": [ { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterActionResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "action_not_found" }, "message": { "type": "string", "const": "Action not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/characters\/public": { "get": { "operationId": "characterPublic.index", "tags": [ "CharacterPublic" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/PublicCharacterResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } } }, "security": [] } }, "\/characters\/public\/{characterName}": { "get": { "operationId": "characterPublic.show", "tags": [ "CharacterPublic" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/PublicCharacterResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/races": { "get": { "operationId": "encyclopedia.races", "tags": [ "Encyclopedia" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/RaceResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/races\/{code}": { "get": { "operationId": "encyclopedia.race", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/RaceResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "race_not_found" }, "message": { "type": "string", "const": "Race not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/classes": { "get": { "operationId": "encyclopedia.classes", "tags": [ "Encyclopedia" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterClassResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/classes\/{code}": { "get": { "operationId": "encyclopedia.classDetail", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterClassResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "class_not_found" }, "message": { "type": "string", "const": "Class not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/items": { "get": { "operationId": "encyclopedia.items", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "craftable", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorldItemResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/items\/{code}": { "get": { "operationId": "encyclopedia.item", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/WorldItemResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "item_not_found" }, "message": { "type": "string", "const": "Item not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/monsters": { "get": { "operationId": "encyclopedia.monsters", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "level", "in": "query", "schema": { "type": "string" } }, { "name": "level_min", "in": "query", "schema": { "type": "string" } }, { "name": "level_max", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/MonsterResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/monsters\/{code}": { "get": { "operationId": "encyclopedia.monster", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/MonsterResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "monster_not_found" }, "message": { "type": "string", "const": "Monster not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/resources": { "get": { "operationId": "encyclopedia.resources", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "skill", "in": "query", "schema": { "type": "string" } }, { "name": "level_required", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/GatheringResourceResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/resources\/{code}": { "get": { "operationId": "encyclopedia.resource", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/GatheringResourceResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "resource_not_found" }, "message": { "type": "string", "const": "Resource not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/maps": { "get": { "operationId": "encyclopedia.maps", "tags": [ "Encyclopedia" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorldMapSummaryResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/achievements": { "get": { "operationId": "encyclopedia.achievements", "tags": [ "Encyclopedia" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/AchievementResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/achievements\/{code}": { "get": { "operationId": "encyclopedia.achievement", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/AchievementResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "achievement_not_found" }, "message": { "type": "string", "const": "Achievement not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/dungeons": { "get": { "operationId": "encyclopedia.dungeons", "tags": [ "Encyclopedia" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/DungeonResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/dungeons\/{code}": { "get": { "operationId": "encyclopedia.dungeon", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/DungeonResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "dungeon_not_found" }, "message": { "type": "string", "const": "Dungeon not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/bosses": { "get": { "operationId": "encyclopedia.bosses", "tags": [ "Encyclopedia" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorldBossResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/bosses\/{code}": { "get": { "operationId": "encyclopedia.boss", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/WorldBossResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "boss_not_found" }, "message": { "type": "string", "const": "World boss not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/encyclopedia\/events": { "get": { "operationId": "encyclopedia.events", "summary": "Specialty world events (time windows + random)", "tags": [ "Encyclopedia" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": {} }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] } }, "required": [ "data", "pagination", "progression" ] } } } } }, "security": [] } }, "\/encyclopedia\/events\/{code}": { "get": { "operationId": "encyclopedia.event", "tags": [ "Encyclopedia" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "null" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "event_not_found" }, "message": { "type": "string", "const": "Event not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } } }, "security": [] } }, "\/events": { "get": { "operationId": "event.index", "summary": "Specialty event schedules for the active season (play Events HUD)", "tags": [ "Event" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": {} }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/leaderboard\/public": { "get": { "operationId": "leaderboardPublic.index", "tags": [ "LeaderboardPublic" ], "parameters": [ { "name": "tab", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "combat", "mining", "woodcutting", "herbalism", "fishing", "skinning", "weaponsmithing", "armorsmithing", "leatherworking", "tailoring", "jewelcrafting", "alchemy", "cooking", null ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/PublicLeaderboardEntryResource" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } }, "security": [] } }, "\/maps": { "get": { "operationId": "map.index", "summary": "All active maps with zones + tiles (play shell loads this once)", "tags": [ "Map" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/maps\/{mapCode}": { "get": { "operationId": "map.show", "tags": [ "Map" ], "parameters": [ { "name": "mapCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "map_not_found" }, "message": { "type": "string", "const": "Map not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/maps\/{mapCode}\/items\/{x}\/{y}": { "get": { "operationId": "map.item", "tags": [ "Map" ], "parameters": [ { "name": "mapCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "y", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/MapItemResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "map_item_not_found" }, "message": { "type": "string", "const": "Map item not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] }, { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "map_not_found" }, "message": { "type": "string", "const": "Map not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "map_destination_out_of_bounds" }, "message": { "type": "string", "const": "Coordinates are out of bounds." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/content-cooldowns": { "get": { "operationId": "map.contentCooldowns", "summary": "Account+app content tile cooldowns. Omit map_code for all maps; pass one or many (`map_code=a,b` or `map_code[]=`)", "tags": [ "Map" ], "parameters": [ { "name": "map_code[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64 } } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "map_id": { "type": "string" }, "map_code": { "type": [ "string", "null" ] }, "x": { "type": "integer" }, "y": { "type": "integer" }, "content_type": { "type": [ "string", "null" ] }, "content_code": { "type": [ "string", "null" ] }, "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": "integer" }, "expiration": { "type": "string" } }, "required": [ "map_id", "map_code", "x", "y", "content_type", "content_code", "total_seconds", "remaining_seconds", "expiration" ] } } }, "required": [ "items" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "map_not_found" }, "message": { "type": "string", "const": "Map not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/party": { "get": { "operationId": "party.index", "tags": [ "Party" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/PartyResource" } }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "party.store", "tags": [ "Party" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ManagePartyRequest" } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/PartyResource" }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/party\/{partyId}": { "put": { "operationId": "party.update", "tags": [ "Party" ], "parameters": [ { "name": "partyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ManagePartyRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/PartyResource" }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "party.destroy", "tags": [ "Party" ], "parameters": [ { "name": "partyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "disbanded": { "type": "boolean" } }, "required": [ "disbanded" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/party\/members\/{characterName}": { "delete": { "operationId": "party.leave", "tags": [ "Party" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "left": { "type": "boolean" }, "character": { "type": "string" } }, "required": [ "left", "character" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/play-loop-templates": { "get": { "operationId": "playLoopTemplate.index", "tags": [ "PlayLoopTemplate" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "playLoopTemplate.replace", "tags": [ "PlayLoopTemplate" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ReplacePlayLoopTemplatesRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/questers": { "get": { "operationId": "quest.index", "tags": [ "Quest" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": {} }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/quester": { "get": { "operationId": "quest.show", "tags": [ "Quest" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "quester": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "code", "name" ] }, "quest_types": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "quest_type": { "type": "string" }, "accept_available_at": { "type": "null" }, "accept_remaining_seconds": { "anyOf": [ { "type": "null" }, { "type": "object" }, { "type": "integer", "enum": [ 0 ] } ] }, "can_accept": { "type": "string" }, "offer": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "quest_type": { "type": "string" }, "level_band": { "type": "string" }, "objectives": { "type": "string" }, "rewards": { "type": "string" }, "accept_cooldown_seconds": { "type": "integer", "enum": [ 86400, 3600, 0 ] } }, "required": [ "code", "name", "description", "quest_type", "level_band", "objectives", "rewards", "accept_cooldown_seconds" ] }, "active": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "quest_type": { "type": "string" }, "status": { "type": "string" }, "objectives": { "type": "array", "items": { "type": "object", "properties": { "": { "type": "string" }, "current": { "type": "integer" } }, "required": [ null, "current" ] } }, "rewards": { "type": "object", "properties": { "gold": { "type": [ "object", "null" ] }, "writ": { "type": [ "object", "null" ] }, "grant_capstone": { "type": "boolean" } }, "required": [ "gold", "writ", "grant_capstone" ] }, "accepted_at": { "type": "string" } }, "required": [ "code", "name", "description", "quest_type", "status", "objectives", "rewards", "accepted_at" ] } }, "required": [ "quest_type", "accept_available_at", "accept_remaining_seconds", "can_accept", "offer", "active" ] }, { "type": "object", "properties": { "quest_type": { "type": "string", "const": "campaign" }, "accept_available_at": { "type": "null" }, "accept_remaining_seconds": { "type": "integer" }, "can_accept": { "type": "boolean" }, "offer": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "quest_type": { "type": "string" }, "level_band": { "type": "string" }, "objectives": { "type": "string" }, "rewards": { "type": "string" }, "accept_cooldown_seconds": { "type": "integer" }, "campaign_step": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "campaign_total": { "type": "integer", "minimum": 0 } }, "required": [ "code", "name", "description", "quest_type", "level_band", "objectives", "rewards", "accept_cooldown_seconds", "campaign_step", "campaign_total" ] }, "active": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "quest_type": { "type": "string" }, "status": { "type": "string" }, "objectives": { "type": "array", "items": { "type": "object", "properties": { "": { "type": "string" }, "current": { "type": "integer" } }, "required": [ null, "current" ] } }, "rewards": { "type": "object", "properties": { "gold": { "type": [ "object", "null" ] }, "writ": { "type": [ "object", "null" ] }, "grant_capstone": { "type": "boolean" } }, "required": [ "gold", "writ", "grant_capstone" ] }, "accepted_at": { "type": "string" }, "campaign_step": { "type": "integer" }, "campaign_total": { "type": "integer", "minimum": 0 } }, "required": [ "code", "name", "description", "quest_type", "status", "objectives", "rewards", "accepted_at", "campaign_step", "campaign_total" ] }, "campaign_step": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "campaign_total": { "type": "integer", "minimum": 0 }, "lock_reason": { "type": "string", "const": "completed" }, "requires_combat_level": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "required": [ "quest_type", "accept_available_at", "accept_remaining_seconds", "can_accept", "offer", "active", "campaign_step", "campaign_total", "lock_reason", "requires_combat_level" ] }, { "type": "null" } ] } }, "active": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "quest_type": { "type": "string" }, "status": { "type": "string" }, "objectives": { "type": "array", "items": { "type": "object", "properties": { "": { "type": "string" }, "current": { "type": "integer" } }, "required": [ null, "current" ] } }, "rewards": { "type": "object", "properties": { "gold": { "type": [ "object", "null" ] }, "writ": { "type": [ "object", "null" ] }, "grant_capstone": { "type": "boolean" } }, "required": [ "gold", "writ", "grant_capstone" ] }, "accepted_at": { "type": "string" } }, "required": [ "code", "name", "description", "quest_type", "status", "objectives", "rewards", "accepted_at" ] } } }, "required": [ "quester", "quest_types", "active" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/quests\/available": { "get": { "operationId": "quest.available", "tags": [ "Quest" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": {} }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/quests": { "get": { "operationId": "quest.active", "tags": [ "Quest" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": {} }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/action\/quest-accept": { "post": { "operationId": "quest.accept", "tags": [ "Quest" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuestActionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "quest": { "type": "string" }, "quest_type": { "type": "object", "properties": { "quest_type": { "type": "string" }, "accept_available_at": { "type": "null" }, "accept_remaining_seconds": { "anyOf": [ { "type": "null" }, { "type": "object" }, { "type": "integer", "enum": [ 0 ] } ] }, "can_accept": { "type": "string" }, "offer": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "quest_type": { "type": "string" }, "level_band": { "type": "string" }, "objectives": { "type": "string" }, "rewards": { "type": "string" }, "accept_cooldown_seconds": { "type": "integer", "enum": [ 86400, 3600, 0 ] } }, "required": [ "code", "name", "description", "quest_type", "level_band", "objectives", "rewards", "accept_cooldown_seconds" ] }, "active": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "quest_type": { "type": "string" }, "status": { "type": "string" }, "objectives": { "type": "array", "items": { "type": "object", "properties": { "": { "type": "string" }, "current": { "type": "integer" } }, "required": [ null, "current" ] } }, "rewards": { "type": "object", "properties": { "gold": { "type": [ "object", "null" ] }, "writ": { "type": [ "object", "null" ] }, "grant_capstone": { "type": "boolean" } }, "required": [ "gold", "writ", "grant_capstone" ] }, "accepted_at": { "type": "string" } }, "required": [ "code", "name", "description", "quest_type", "status", "objectives", "rewards", "accepted_at" ] } }, "required": [ "quest_type", "accept_available_at", "accept_remaining_seconds", "can_accept", "offer", "active" ] } }, "required": [ "character", "quest", "quest_type" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/quest-abandon": { "post": { "operationId": "quest.abandon", "tags": [ "Quest" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuestActionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "quest": { "type": "string" } }, "required": [ "character", "quest" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/quest-turn-in": { "post": { "operationId": "quest.turnIn", "tags": [ "Quest" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/QuestActionRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "quest": { "type": "string" }, "rewards": { "type": "string" } }, "required": [ "character", "quest", "rewards" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/self": { "get": { "operationId": "self", "tags": [ "Self" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/UserResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "patch": { "operationId": "self.update", "tags": [ "Self" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateSelfRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/UserResource" }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/tokens": { "get": { "operationId": "token.index", "tags": [ "Token" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/TokenResource" } }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/tokens\/{tokenId}": { "delete": { "operationId": "token.destroy", "tags": [ "Token" ], "parameters": [ { "name": "tokenId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "revoked": { "type": "boolean" }, "id": { "type": "integer" } }, "required": [ "revoked", "id" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "token_not_found" }, "message": { "type": "string", "const": "Token not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/vendors": { "get": { "operationId": "vendor.index", "summary": "Active vendors for the app (refresh timers + map locations)", "tags": [ "Vendor" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "page", "per_page", "total", "last_page" ] }, "": { "type": "string" } }, "required": [ "data", "pagination", null ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/vendor": { "get": { "operationId": "vendor.show", "tags": [ "Vendor" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "vendor": { "type": "array", "items": {} }, "rotation": { "type": "array", "items": {} }, "offers": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": [ "vendor", "rotation", "offers" ] }, { "type": "string" } ] }, "": { "type": "string" } }, "required": [ "data", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/my\/{characterName}\/action\/vendor-purchase": { "post": { "operationId": "vendor.purchase", "tags": [ "Vendor" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VendorTradeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "trade": { "type": "string" }, "shop": { "type": "object", "properties": { "vendor": { "type": "array", "items": {} }, "rotation": { "type": "array", "items": {} }, "offers": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": [ "vendor", "rotation", "offers" ] } }, "required": [ "character", "trade", "shop" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/my\/{characterName}\/action\/vendor-sale": { "post": { "operationId": "vendor.sell", "tags": [ "Vendor" ], "parameters": [ { "name": "characterName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VendorTradeRequest" } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "character": { "type": "array", "items": {} }, "trade": { "type": "string" }, "shop": { "type": "object", "properties": { "vendor": { "type": "array", "items": {} }, "rotation": { "type": "array", "items": {} }, "offers": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": [ "vendor", "rotation", "offers" ] } }, "required": [ "character", "trade", "shop" ] }, { "type": "string" } ] }, "cooldown": { "type": "object", "properties": { "total_seconds": { "type": "integer" }, "remaining_seconds": { "type": [ "object", "null" ] }, "expiration": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "total_seconds", "remaining_seconds", "expiration", "reason" ] }, "": { "type": "string" } }, "required": [ "data", "cooldown", null ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "const": "character_not_found" }, "message": { "type": "string", "const": "Character not found." }, "details": { "type": "null" } }, "required": [ "code", "message", "details" ] } }, "required": [ "error" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "schemas": { "AchievementResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "scope": { "type": "string" }, "category": { "type": "string" }, "difficulty": { "type": "string" }, "points": { "type": "integer" }, "targets": { "type": "array", "items": {} }, "rewards": { "type": [ "array", "null" ], "items": {} }, "sort_order": { "type": "integer" } }, "required": [ "code", "name", "description", "scope", "category", "difficulty", "points", "targets", "rewards", "sort_order" ], "title": "AchievementResource" }, "BankTransferRequest": { "type": "object", "properties": { "item": { "type": [ "string", "null" ], "maxLength": 64 }, "quantity": { "type": [ "integer", "null" ], "minimum": 1 }, "gold": { "type": [ "integer", "null" ], "minimum": 1 } }, "title": "BankTransferRequest" }, "CharacterActionResource": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "action_type": { "type": "string" }, "outcome": { "type": [ "string", "null" ] }, "seed": { "type": [ "string", "null" ] }, "result": { "type": [ "array", "null" ], "items": {} }, "cooldown_seconds": { "type": [ "integer", "null" ] }, "cooldown_expires_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "character_name": { "type": "string" } }, "required": [ "id", "action_type", "outcome", "seed", "result", "cooldown_seconds", "cooldown_expires_at", "created_at" ], "title": "CharacterActionResource" }, "CharacterActionResultResource": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "name": { "type": "string" }, "is_active": { "type": "boolean" }, "gender": { "type": "string" }, "race": { "anyOf": [ { "$ref": "#\/components\/schemas\/RaceResource" }, { "type": "null" } ] }, "class": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterClassResource" }, { "type": "null" } ] }, "map": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterMapResource" }, { "type": "null" } ] }, "combat": { "type": "string" }, "hp": { "type": "object", "properties": { "current": { "type": "integer" }, "max": { "type": "string" } }, "required": [ "current", "max" ] }, "stats": { "type": "string" }, "abilities": { "type": "string" }, "buffs": { "type": "string" }, "gold": { "type": "integer" }, "cooldown": { "type": "string" }, "activity": { "type": "string" }, "inventory_slots": { "type": "string" }, "skills": { "type": "string" }, "equipment": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterEquipmentResource" } }, "inventory": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterInventoryResource" } }, "bonfire": { "type": [ "object", "null" ], "properties": { "map": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] } }, "required": [ "id", "code" ] }, "x": { "type": "integer" }, "y": { "type": "integer" }, "station": { "type": "string", "const": "bonfire" } }, "required": [ "map", "x", "y", "station" ] } }, "required": [ "id", "name", "is_active", "gender", "combat", "hp", "stats", "abilities", "buffs", "gold", "cooldown", "activity", "bonfire" ], "title": "CharacterActionResultResource" }, "CharacterClassResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "base_stats": { "type": "array", "items": {} }, "starter_item": { "type": [ "string", "null" ] }, "level_growth": { "type": "array", "items": {} }, "tags": { "type": "array", "items": { "type": "string" } }, "equip_allow": { "type": "string" }, "abilities": { "type": "string" } }, "required": [ "code", "name", "base_stats", "starter_item", "level_growth", "tags", "equip_allow", "abilities" ], "title": "CharacterClassResource" }, "CharacterEquipmentResource": { "type": "object", "properties": { "slot": { "type": "string" }, "item": { "anyOf": [ { "$ref": "#\/components\/schemas\/WorldItemResource" }, { "type": "null" } ] } }, "required": [ "slot" ], "title": "CharacterEquipmentResource" }, "CharacterInventoryResource": { "type": "object", "properties": { "quantity": { "type": "integer" }, "item": { "anyOf": [ { "$ref": "#\/components\/schemas\/WorldItemResource" }, { "type": "null" } ] } }, "required": [ "quantity" ], "title": "CharacterInventoryResource" }, "CharacterMapResource": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "x": { "type": "integer" }, "y": { "type": "integer" } }, "required": [ "id", "code", "x", "y" ], "title": "CharacterMapResource" }, "CharacterPlayResource": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "name": { "type": "string" }, "is_active": { "type": "boolean" }, "gender": { "type": "string" }, "race": { "anyOf": [ { "$ref": "#\/components\/schemas\/RaceResource" }, { "type": "null" } ] }, "class": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterClassResource" }, { "type": "null" } ] }, "map": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterMapResource" }, { "type": "null" } ] }, "combat": { "type": "string" }, "hp": { "type": "object", "properties": { "current": { "type": "integer" }, "max": { "type": "string" } }, "required": [ "current", "max" ] }, "stats": { "type": "string" }, "abilities": { "type": "string" }, "gold": { "type": "integer" }, "cooldown": { "type": "string" }, "activity": { "type": "string" } }, "required": [ "id", "name", "is_active", "gender", "combat", "hp", "stats", "abilities", "gold", "cooldown", "activity" ], "title": "CharacterPlayResource" }, "CharacterResource": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "name": { "type": "string" }, "is_active": { "type": "boolean" }, "gender": { "type": "string" }, "race": { "anyOf": [ { "$ref": "#\/components\/schemas\/RaceResource" }, { "type": "null" } ] }, "class": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterClassResource" }, { "type": "null" } ] }, "map": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterMapResource" }, { "type": "null" } ] }, "combat": { "type": "string" }, "hp": { "type": "object", "properties": { "current": { "type": "integer" }, "max": { "type": "string" } }, "required": [ "current", "max" ] }, "stats": { "type": "string" }, "abilities": { "type": "string" }, "buffs": { "type": "string" }, "gold": { "type": "integer" }, "cooldown": { "type": "string" }, "activity": { "type": "string" }, "inventory_slots": { "type": "string" }, "skills": { "type": "string" }, "equipment": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterEquipmentResource" } }, "inventory": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterInventoryResource" } }, "bonfire": { "type": [ "object", "null" ], "properties": { "map": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] } }, "required": [ "id", "code" ] }, "x": { "type": "integer" }, "y": { "type": "integer" }, "station": { "type": "string", "const": "bonfire" } }, "required": [ "map", "x", "y", "station" ] } }, "required": [ "id", "name", "is_active", "gender", "combat", "hp", "stats", "abilities", "buffs", "gold", "cooldown", "activity", "bonfire" ], "title": "CharacterResource" }, "ClearDungeonRequest": { "type": "object", "properties": { "dungeon": { "type": "string", "maxLength": 64 }, "battle_settings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "target_strategy": { "type": [ "string", "null" ], "enum": [ "weakest", "random", "focused", null ] }, "recast_hots": { "type": [ "boolean", "null" ] }, "battle_pot": { "type": [ "object", "null" ], "properties": { "item": { "type": "string", "maxLength": 120 }, "when": { "type": [ "object", "null" ], "properties": { "hp_below_pct": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 99 } } } } } } } }, "path": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 64 }, "minItems": 1 }, "difficulty": { "type": [ "string", "null" ], "maxLength": 32 } }, "required": [ "dungeon" ], "title": "ClearDungeonRequest" }, "ContentDropResource": { "type": "object", "properties": { "item": { "anyOf": [ { "$ref": "#\/components\/schemas\/WorldItemResource" }, { "type": "null" } ] }, "source": { "type": "string" }, "rate": { "type": "integer" }, "chance": { "type": "string" }, "min_quantity": { "type": "integer" }, "max_quantity": { "type": "integer" }, "pity": { "type": "boolean" } }, "required": [ "source", "rate", "chance", "min_quantity", "max_quantity", "pity" ], "title": "ContentDropResource" }, "CraftItemRequest": { "type": "object", "properties": { "item": { "type": "string", "maxLength": 64 }, "quantity": { "type": "integer", "minimum": 1, "maximum": 99 } }, "required": [ "item" ], "title": "CraftItemRequest" }, "CreateCharacterRequest": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_ -]*$", "minLength": 3, "maxLength": 32 }, "race": { "type": "string", "maxLength": 64 }, "class": { "type": "string", "maxLength": 64 }, "gender": { "type": "string", "enum": [ "male", "female" ] } }, "required": [ "name", "race", "class", "gender" ], "title": "CreateCharacterRequest" }, "DestroyItemRequest": { "type": "object", "properties": { "item_code": { "type": "string", "maxLength": 64 }, "quantity": { "type": [ "integer", "null" ], "minimum": 1 } }, "required": [ "item_code" ], "title": "DestroyItemRequest" }, "DungeonResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "clear_mode": { "type": "string" }, "entry_node": { "type": [ "string", "null" ] }, "final_node": { "type": [ "string", "null" ] }, "wave_count": { "type": "integer" }, "level": { "anyOf": [ { "type": "integer" }, { "type": "null" }, { "type": "object" } ] }, "level_min": { "anyOf": [ { "type": "integer" }, { "type": "null" }, { "type": "object" } ] }, "level_max": { "anyOf": [ { "type": "integer" }, { "type": "null" }, { "type": "object" } ] }, "waves": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "monsters": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "integer" }, "level": { "type": "integer" } }, "required": [ "code", "name", "quantity", "level" ] } } }, "required": [ "index", "monsters" ] } }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "kind": { "type": "string" }, "required": { "type": "boolean" }, "sort_order": { "type": "integer" }, "monsters": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "integer" }, "level": { "type": "integer" } }, "required": [ "code", "name", "quantity", "level" ] } } }, "required": [ "code", "kind", "required", "sort_order", "monsters" ] } }, "edges": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": [ "string", "null" ] }, "to": { "type": [ "string", "null" ] } }, "required": [ "from", "to" ] } }, "locations": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "global_cooldown": { "type": "integer" }, "default_difficulty": { "type": "string" }, "difficulties": { "type": "array", "items": { "type": "object", "properties": { "mode": { "type": "string" }, "global_cooldown": { "type": "string" }, "min_party": { "type": "string" }, "stat_scale_pct": { "type": "string" }, "content_code": { "type": "string" } }, "required": [ "mode", "global_cooldown", "min_party", "stat_scale_pct", "content_code" ] } } }, "required": [ "code", "name", "clear_mode", "entry_node", "final_node", "wave_count", "level", "level_min", "level_max", "waves", "nodes", "edges", "locations", "global_cooldown", "default_difficulty", "difficulties" ], "title": "DungeonResource" }, "EquipItemRequest": { "type": "object", "properties": { "item_code": { "type": "string", "maxLength": 64 }, "slot": { "type": [ "string", "null" ], "maxLength": 32 } }, "required": [ "item_code" ], "title": "EquipItemRequest" }, "FightBattleSettingsRequest": { "type": "object", "properties": { "content_code": { "type": [ "string", "null" ], "maxLength": 120 }, "battle_settings": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "target_strategy": { "type": [ "string", "null" ], "enum": [ "weakest", "random", "focused", null ] }, "recast_hots": { "type": [ "boolean", "null" ] }, "battle_pot": { "type": [ "object", "null" ], "properties": { "item": { "type": "string", "maxLength": 120 }, "when": { "type": [ "object", "null" ], "properties": { "hp_below_pct": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 99 } } } } } } } } }, "title": "FightBattleSettingsRequest" }, "GatherResourceRequest": { "type": "object", "properties": { "content_code": { "type": [ "string", "null" ], "maxLength": 120 } }, "title": "GatherResourceRequest" }, "GatheringResourceResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "skill": { "type": "string" }, "level_required": { "type": "integer" }, "cooldown": { "type": "integer" }, "global_cooldown": { "type": "integer" }, "xp_reward": { "type": "integer" }, "tags": { "type": "array", "items": { "type": "string" } }, "locations": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "drops": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "rate": { "type": [ "object", "null" ] }, "chance": { "type": "string" }, "min_quantity": { "type": [ "object", "null" ] }, "max_quantity": { "type": [ "object", "null" ] } }, "required": [ "code", "rate", "chance", "min_quantity", "max_quantity" ] } } }, "required": [ "code", "name", "skill", "level_required", "cooldown", "global_cooldown", "xp_reward", "tags", "locations", "drops" ], "title": "GatheringResourceResource" }, "LoginRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" }, "token_name": { "type": "string", "maxLength": 64 } }, "required": [ "email", "password", "token_name" ], "title": "LoginRequest" }, "ManagePartyRequest": { "type": "object", "properties": { "character_names": { "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 32 }, "minItems": 1, "maxItems": 5 } }, "required": [ "character_names" ], "title": "ManagePartyRequest" }, "MapItemResource": { "type": "object", "properties": { "x": { "type": "integer" }, "y": { "type": "integer" }, "terrain_code": { "type": "string" }, "terrain_skin": { "type": "string" }, "visual": { "type": "object", "properties": { "skin": { "type": "string" }, "rotate": { "type": "integer" }, "content_baked": { "type": "string" } }, "required": [ "skin", "rotate", "content_baked" ] }, "is_walkable": { "type": "boolean" }, "move_cost": { "type": "integer" }, "zone": { "type": [ "array", "null" ], "items": {} }, "contents": { "type": "string" }, "events": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": [ "x", "y", "terrain_code", "terrain_skin", "visual", "is_walkable", "move_cost", "contents", "events" ], "title": "MapItemResource" }, "MonsterResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "level": { "type": "integer" }, "stats": { "type": "array", "items": {} }, "attack_strategy": { "type": "string" }, "xp_reward": { "type": "integer" }, "gold": { "type": "object", "properties": { "min": { "type": "integer" }, "max": { "type": "integer" } }, "required": [ "min", "max" ] }, "global_cooldown": { "type": "integer" }, "tags": { "type": "array", "items": { "type": "string" } }, "abilities": { "type": "string" }, "locations": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "dungeons": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "drops": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContentDropResource" } } }, "required": [ "code", "name", "level", "stats", "attack_strategy", "xp_reward", "gold", "global_cooldown", "tags", "abilities", "locations", "dungeons" ], "title": "MonsterResource" }, "MoveCharacterRequest": { "type": "object", "properties": { "x": { "type": "integer" }, "y": { "type": "integer" } }, "required": [ "x", "y" ], "title": "MoveCharacterRequest" }, "PartyMemberResource": { "type": "object", "properties": { "sort_order": { "type": "integer" }, "character": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterResource" }, { "type": "null" } ] } }, "required": [ "sort_order" ], "title": "PartyMemberResource" }, "PartyResource": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "status": { "type": "string" }, "leader": { "type": [ "object", "null" ], "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "members": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PartyMemberResource" } } }, "required": [ "id", "status" ], "title": "PartyResource" }, "PublicAccountResource": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "display_name": { "type": [ "string", "null" ] } }, "required": [ "id", "display_name" ], "title": "PublicAccountResource" }, "PublicCharacterResource": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "name": { "type": "string" }, "is_active": { "type": "boolean" }, "gender": { "type": "string" }, "account": { "anyOf": [ { "$ref": "#\/components\/schemas\/PublicAccountResource" }, { "type": "null" } ] }, "race": { "anyOf": [ { "$ref": "#\/components\/schemas\/RaceResource" }, { "type": "null" } ] }, "class": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterClassResource" }, { "type": "null" } ] }, "map": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterMapResource" }, { "type": "null" } ] }, "combat": { "type": "string" }, "stats": { "type": "string" }, "skills": { "type": "string" }, "equipment": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CharacterEquipmentResource" } } }, "required": [ "id", "name", "is_active", "gender", "combat", "stats" ], "title": "PublicCharacterResource" }, "PublicLeaderboardEntryResource": { "type": "object", "properties": { "rank": { "type": "integer" }, "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "name": { "type": "string" }, "gender": { "type": "string" }, "account": { "anyOf": [ { "$ref": "#\/components\/schemas\/PublicAccountResource" }, { "type": "null" } ] }, "race": { "anyOf": [ { "$ref": "#\/components\/schemas\/RaceResource" }, { "type": "null" } ] }, "class": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterClassResource" }, { "type": "null" } ] }, "map": { "anyOf": [ { "$ref": "#\/components\/schemas\/CharacterMapResource" }, { "type": "null" } ] }, "progression": { "type": "object", "properties": { "track": { "anyOf": [ { "type": "array", "items": {} }, { "type": "null" }, { "type": "string" } ] }, "level": { "type": "integer" }, "xp": { "type": "integer" } }, "required": [ "track", "level", "xp" ] } }, "required": [ "rank", "id", "name", "gender", "progression" ], "title": "PublicLeaderboardEntryResource" }, "QuestActionRequest": { "type": "object", "properties": { "quest_code": { "type": "string", "maxLength": 64 } }, "required": [ "quest_code" ], "title": "QuestActionRequest" }, "RaceResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "start_map": { "type": [ "array", "null" ], "items": {} }, "stat_modifiers": { "type": "array", "items": {} }, "allowed_classes": { "type": "array", "items": { "type": "string" } } }, "required": [ "code", "name", "start_map", "stat_modifiers", "allowed_classes" ], "title": "RaceResource" }, "RegisterRequest": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "password": { "type": "string", "minLength": 8 }, "display_name": { "type": [ "string", "null" ], "maxLength": 64 }, "token_name": { "type": "string", "maxLength": 64 }, "password_confirmation": { "type": "string", "minLength": 8 } }, "required": [ "email", "password", "token_name", "password_confirmation" ], "title": "RegisterRequest" }, "ReplacePlayLoopTemplatesRequest": { "type": "object", "properties": { "templates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 40 }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "character", "party" ] }, "character_names": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 32 }, "minItems": 1 } }, "required": [ "kind", "character_names" ] }, "auto_travel": { "type": "boolean" }, "highlight_next_step": { "type": "boolean" }, "stop_when": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "lt", "lte", "gt", "gte", "eq" ] }, "left": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "inventory_qty", "gold", "hp_pct", "free_bag_slots", "skill_level", "loop_count" ] }, "item_code": { "type": [ "string", "null" ], "maxLength": 64 }, "skill_track": { "type": [ "string", "null" ], "maxLength": 64 } } }, "right": { "type": "number" } } }, "maxItems": 5 }, "pause_when": { "type": "array", "items": { "type": "string" }, "maxItems": 5 }, "default_retry": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 5 }, "on_fail": { "type": "string", "enum": [ "skip", "stop", "error" ] } } }, "steps": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "fight", "gather", "dungeon", "skin", "rest", "travel", "bank", "craft", "vendor", "quest", "use_item", "drop_item" ] }, "label": { "type": [ "string", "null" ], "maxLength": 40 }, "if_available": { "type": "boolean" }, "is_full_hp": { "type": "boolean" }, "auto_skin": { "type": "boolean" }, "content_code": { "type": [ "string", "null" ], "maxLength": 64 }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "lt", "lte", "gt", "gte", "eq" ] }, "left": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "inventory_qty", "gold", "hp_pct", "free_bag_slots", "skill_level" ] }, "item_code": { "type": [ "string", "null" ], "maxLength": 64 }, "skill_track": { "type": [ "string", "null" ], "maxLength": 64 } } }, "right": { "type": "number" } } }, "maxItems": 5 }, "skip_when": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "lt", "lte", "gt", "gte", "eq" ] }, "left": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "inventory_qty", "gold", "hp_pct", "free_bag_slots", "skill_level" ] }, "item_code": { "type": [ "string", "null" ], "maxLength": 64 }, "skill_track": { "type": [ "string", "null" ], "maxLength": 64 } } }, "right": { "type": "number" } } }, "maxItems": 5 }, "stop_when": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "lt", "lte", "gt", "gte", "eq" ] }, "left": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "inventory_qty", "gold", "hp_pct", "free_bag_slots", "skill_level", "loop_count" ] }, "item_code": { "type": [ "string", "null" ], "maxLength": 64 }, "skill_track": { "type": [ "string", "null" ], "maxLength": 64 } } }, "right": { "type": "number" } } }, "maxItems": 5 }, "battle_settings": { "type": "object", "properties": { "target_strategy": { "type": "string", "enum": [ "weakest", "random", "focused" ] }, "battle_pot": { "type": [ "object", "null" ], "properties": { "item": { "type": "string", "maxLength": 64 }, "when": { "type": "object", "properties": { "hp_below_pct": { "type": "integer", "minimum": 1, "maximum": 99 } } } } } } }, "bank": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "deposit", "withdraw" ] }, "item_code": { "type": [ "string", "null" ], "maxLength": 64 }, "quantity": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 9999 }, "gold": { "type": [ "integer", "null" ], "minimum": 1 }, "dump_all": { "type": "boolean" }, "gold_all": { "type": "boolean" } } }, "craft": { "type": "object", "properties": { "item_code": { "type": [ "string", "null" ], "maxLength": 64 }, "quantity": { "type": "integer", "minimum": 1, "maximum": 99 }, "mode": { "type": "string", "enum": [ "fixed", "until_empty", "while_possible" ] }, "when": { "type": "array", "items": { "type": "string" }, "maxItems": 5 } } }, "vendor": { "type": "object", "properties": { "side": { "type": "string", "enum": [ "buy", "sell" ] }, "item_code": { "type": [ "string", "null" ], "maxLength": 64 }, "quantity": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 99 }, "only_if_available": { "type": "boolean" } } }, "quest": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "accept", "turn_in" ] }, "types": { "type": "array", "items": { "type": "string", "enum": [ "hourly", "daily" ] } } } }, "use_item": { "type": "object", "properties": { "item_code": { "type": [ "string", "null" ], "maxLength": 64 } } }, "drop_item": { "type": "object", "properties": { "item_code": { "type": [ "string", "null" ], "maxLength": 64 }, "quantity": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 9999 } } }, "pause_when": { "type": "array", "items": { "type": "string" }, "maxItems": 5 }, "branch_when": { "type": "array", "items": { "type": "object", "properties": { "step_index": { "type": "integer", "minimum": 0 }, "conditions": { "type": "array", "items": { "type": "string" }, "maxItems": 5 } } }, "maxItems": 5 }, "retry": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 5 }, "on_fail": { "type": "string", "enum": [ "skip", "stop", "error" ] } } }, "location": { "type": [ "object", "null" ], "properties": { "map_code": { "type": "string", "maxLength": 64 }, "x": { "type": "integer" }, "y": { "type": "integer" } } } }, "required": [ "action" ] }, "minItems": 1, "maxItems": 10 }, "updated_at": { "type": [ "string", "null" ] }, "last_run": { "type": [ "object", "null" ], "properties": { "at": { "type": "string", "maxLength": 64 }, "status": { "type": "string", "enum": [ "stopped", "error", "paused" ] }, "message": { "type": "string", "maxLength": 500 }, "step_index": { "type": "integer" }, "loop_count": { "type": "integer", "minimum": 0 }, "duration_ms": { "type": "integer", "minimum": 0 }, "gold_delta": { "type": "integer" }, "trigger": { "type": [ "string", "null" ], "maxLength": 200 } } } }, "required": [ "name", "target", "steps" ] }, "minItems": 1, "maxItems": 10 } }, "required": [ "templates" ], "title": "ReplacePlayLoopTemplatesRequest" }, "TokenResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "abilities": { "type": [ "array", "null" ], "items": {} }, "last_used_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "abilities", "last_used_at", "expires_at", "created_at" ], "title": "TokenResource" }, "UnequipItemRequest": { "type": "object", "properties": { "slot": { "type": "string", "maxLength": 32 } }, "required": [ "slot" ], "title": "UnequipItemRequest" }, "UpdateCharacterActiveRequest": { "type": "object", "properties": { "is_active": { "type": "boolean" } }, "required": [ "is_active" ], "title": "UpdateCharacterActiveRequest" }, "UpdateSelfRequest": { "type": "object", "properties": { "default_app": { "type": "string", "maxLength": 64 } }, "required": [ "default_app" ], "title": "UpdateSelfRequest" }, "UseConsumableRequest": { "type": "object", "properties": { "item": { "type": "string", "maxLength": 120 } }, "required": [ "item" ], "title": "UseConsumableRequest" }, "UserAppResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "is_default": { "type": "boolean" }, "joined_at": { "type": "string" } }, "required": [ "code", "name", "status", "is_default", "joined_at" ], "title": "UserAppResource" }, "UserResource": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "integer" }, { "type": "object" } ] }, "email": { "type": "string" }, "display_name": { "type": [ "string", "null" ] }, "profile": { "type": "array", "items": {} }, "default_app": { "type": "string" }, "apps": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserAppResource" } }, "progression": { "type": "object", "properties": { "min_level": { "type": "integer", "const": 1 }, "max_level": { "type": "integer", "const": 40 } }, "required": [ "min_level", "max_level" ] }, "created_at": { "type": [ "string", "null" ] } }, "required": [ "id", "email", "display_name", "default_app", "apps", "progression", "created_at" ], "title": "UserResource" }, "VendorTradeRequest": { "type": "object", "properties": { "offer_id": { "type": "string", "format": "uuid" }, "quantity": { "type": "integer", "minimum": 1, "maximum": 99 } }, "required": [ "offer_id" ], "title": "VendorTradeRequest" }, "WorldBossResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "level": { "type": [ "integer", "null" ] }, "encounter_type": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "requires_party": { "type": "boolean" }, "reset_hour_utc": { "type": "integer" }, "resets_at_label": { "type": "string" }, "charges": { "type": [ "object", "null" ], "properties": { "max": { "type": [ "object", "null" ] }, "auto_bonus_from": { "type": [ "object", "null" ] }, "auto_bonus_pct_per_above": { "type": [ "object", "null" ] } }, "required": [ "max", "auto_bonus_from", "auto_bonus_pct_per_above" ] }, "mechanics": { "type": "array", "items": {} }, "win_condition": { "type": [ "string", "null" ] }, "day_fail": { "type": [ "string", "null" ] }, "locations": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "pack": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "string" }, "level": { "type": "null" }, "role": { "type": "string", "enum": [ "boss", "add" ] }, "monster": { "type": "null" } }, "required": [ "code", "name", "quantity", "level", "role", "monster" ] }, { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "string" }, "level": { "type": "integer" }, "role": { "type": "string", "enum": [ "boss", "add" ] }, "monster": { "type": "array", "items": {} } }, "required": [ "code", "name", "quantity", "level", "role", "monster" ] }, { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "integer" }, "level": { "type": "integer" }, "role": { "type": "string", "const": "summon" }, "monster": { "type": "array", "items": {} } }, "required": [ "code", "name", "quantity", "level", "role", "monster" ] } ] } }, "ally": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" }, "level": { "type": "integer" }, "role": { "type": "string", "const": "ally" }, "monster": { "type": "array", "items": {} } }, "required": [ "code", "name", "id", "level", "role", "monster" ] }, { "type": "object", "properties": { "code": { "type": "string" }, "id": { "type": "string" }, "role": { "type": "string", "const": "ally" }, "monster": { "type": "null" } }, "required": [ "code", "id", "role", "monster" ] }, { "type": "null" } ] }, "state": { "type": [ "string", "null" ] } }, "required": [ "code", "name", "level", "encounter_type", "description", "requires_party", "reset_hour_utc", "resets_at_label", "charges", "mechanics", "win_condition", "day_fail", "locations", "pack", "ally", "state" ], "title": "WorldBossResource" }, "WorldItemResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "item_level": { "type": "integer" }, "rarity": { "type": "string" }, "base_value": { "type": "integer" }, "equipment_slot": { "type": [ "string", "null" ] }, "is_stackable": { "type": "boolean" }, "max_stack": { "type": "integer" }, "stat_modifiers": { "type": "array", "items": {} }, "tags": { "type": "array", "items": { "type": "string" } }, "craft": { "type": [ "array", "null" ], "items": {} }, "gather_sources": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "drop_sources": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "code", "name", "type", "item_level", "rarity", "base_value", "equipment_slot", "is_stackable", "max_stack", "stat_modifiers", "tags", "craft" ], "title": "WorldItemResource" }, "WorldMapSummaryResource": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "layer": { "type": "string" }, "region": { "type": [ "string", "null" ] }, "width": { "type": "integer" }, "height": { "type": "integer" }, "bounds": { "type": "array", "items": {} }, "is_start_map": { "type": "boolean" }, "spawn": { "type": "array", "items": {} } }, "required": [ "code", "name", "layer", "region", "width", "height", "bounds", "is_start_map", "spawn" ], "title": "WorldMapSummaryResource" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }