{ "openapi": "3.1.0", "info": { "title": "平安志工作台数据接口", "version": "1.0.0", "description": "本机数据仅通过回环接口读取；NAS仅分发公共活动资料。" }, "servers": [ { "url": "http://127.0.0.1:{port}", "description": "端口由设置页显示，每次启动可能变化", "variables": { "port": { "default": "0" } } } ], "paths": { "/v1/context": { "get": { "summary": "档案与权限", "security": [ { "LocalBearer": [] } ], "parameters": [], "responses": { "200": { "description": "当前快照或本机活动缓存", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Envelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Context" } } } ] } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "令牌无效", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "会员不足或来源拒绝", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "档案在查询中切换，请重试", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "限流，Retry-After 秒", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "数据暂不可读取", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tasks": { "get": { "summary": "原始任务与手动记录", "security": [ { "LocalBearer": [] } ], "parameters": [ { "name": "profileId", "in": "query", "required": false, "description": "查询指定本机已导入角色的当前档案；省略时查询激活角色，不切换全局角色。", "schema": { "type": "string" } } ], "responses": { "200": { "description": "当前快照或本机活动缓存", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Envelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tasks" } } } ] } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "令牌无效", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "会员不足或来源拒绝", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "档案在查询中切换，请重试", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "限流，Retry-After 秒", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "数据暂不可读取", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/realm-cards": { "get": { "summary": "结界卡状态", "security": [ { "LocalBearer": [] } ], "parameters": [], "responses": { "200": { "description": "当前快照或本机活动缓存", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Envelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RealmCards" } } } ] } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "令牌无效", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "会员不足或来源拒绝", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "档案在查询中切换，请重试", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "限流，Retry-After 秒", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "数据暂不可读取", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/guild": { "get": { "summary": "寮概况与成员", "security": [ { "LocalBearer": [] } ], "parameters": [], "responses": { "200": { "description": "当前快照或本机活动缓存", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Envelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Guild" } } } ] } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "令牌无效", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "会员不足或来源拒绝", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "档案在查询中切换，请重试", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "限流，Retry-After 秒", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "数据暂不可读取", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/profile-summary": { "get": { "summary": "档案摘要", "security": [ { "LocalBearer": [] } ], "parameters": [], "responses": { "200": { "description": "当前快照或本机活动缓存", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Envelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProfileSummary" } } } ] } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "令牌无效", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "会员不足或来源拒绝", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "档案在查询中切换，请重试", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "限流，Retry-After 秒", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "数据暂不可读取", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/activities": { "get": { "summary": "本机活动查询", "security": [ { "LocalBearer": [] } ], "parameters": [ { "name": "server", "in": "query", "schema": { "enum": ["live", "test"] } }, { "name": "q", "in": "query", "schema": { "type": "string", "maxLength": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "当前快照或本机活动缓存", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Envelope" }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "version": { "type": ["string", "null"] }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } }, "required": ["version", "total", "items"] } } } ] } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "令牌无效", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "会员不足或来源拒绝", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "档案在查询中切换，请重试", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "限流，Retry-After 秒", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "数据暂不可读取", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/announcements": { "get": { "summary": "本机公告查询", "security": [ { "LocalBearer": [] } ], "parameters": [ { "name": "server", "in": "query", "schema": { "enum": ["live", "test"] } }, { "name": "q", "in": "query", "schema": { "type": "string", "maxLength": 200 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "当前快照或本机活动缓存", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Envelope" }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "version": { "type": ["string", "null"] }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Announcement" } } }, "required": ["version", "total", "items"] } } } ] } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "令牌无效", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "会员不足或来源拒绝", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "档案在查询中切换，请重试", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "限流，Retry-After 秒", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "数据暂不可读取", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/manifest": { "get": { "summary": "独立NAS服务：当前数据版本", "security": [], "servers": [ { "url": "https://activity.example.invalid", "description": "替换为独立活动服务地址" } ], "responses": { "200": { "description": "版本和哈希", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Manifest" } } } }, "304": { "description": "版本未改变" }, "429": { "description": "限流" } } } }, "/v1/packages/{version}.json": { "get": { "summary": "独立NAS服务：不可变数据包", "security": [], "servers": [ { "url": "https://activity.example.invalid" } ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "SHA-256 对应 manifest.sha256", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Packet" } } } }, "304": { "description": "未改变" }, "404": { "description": "尚未发布" }, "429": { "description": "限流" } } } } }, "components": { "securitySchemes": { "LocalBearer": { "type": "http", "scheme": "bearer", "description": "从设置页复制本机令牌；插件不持有主令牌。" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" } }, "required": ["code"] } }, "required": ["error"] }, "Envelope": { "type": "object", "properties": { "apiVersion": { "const": 1 }, "profileId": { "type": ["string", "null"] }, "capturedAt": { "type": ["string", "null"], "format": "date-time" }, "fetchedAt": { "type": "string", "format": "date-time" }, "data": {}, "snapshotId": { "type": ["string", "null"] } }, "required": [ "apiVersion", "profileId", "capturedAt", "fetchedAt", "data", "snapshotId" ] }, "Context": { "type": "object", "properties": { "profileId": { "type": ["string", "null"] }, "member": { "type": "boolean" }, "permissions": { "type": "object", "properties": { "weekly_tasks": { "type": "boolean" }, "realm_cards": { "type": "boolean" } } }, "activityVersion": { "type": ["string", "null"] }, "snapshotId": { "type": ["string", "null"] } } }, "ManualPeriod": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "ids": { "type": "array", "items": { "type": "string" } } }, "required": ["period", "ids"] }, "RealmStatus": { "type": "object", "properties": { "available": { "type": "boolean" }, "active": { "type": "boolean" }, "itemId": { "type": ["integer", "null"] }, "startedAt": { "type": ["number", "null"], "description": "Unix 秒" }, "endsAt": { "type": ["number", "null"], "description": "Unix 秒；到期仅表示快照推算" }, "expectedJade": { "type": ["number", "null"] }, "expectedStamina": { "type": ["number", "null"] }, "status": { "type": "string", "enum": ["unknown", "inactive", "active", "expired"] } }, "required": ["available"] }, "RealmCards": { "type": ["object", "null"], "properties": { "own": { "$ref": "#/components/schemas/RealmStatus" }, "foster": { "$ref": "#/components/schemas/RealmStatus" } } }, "Tasks": { "type": "object", "properties": { "records": { "type": ["object", "null"], "properties": { "schemaVersion": { "type": "integer" }, "capturedAt": { "type": ["string", "null"], "format": "date-time" }, "daily": { "type": "object", "additionalProperties": true }, "weekly": { "type": "object", "additionalProperties": true }, "realmCardStatus": { "$ref": "#/components/schemas/RealmCards" } } }, "manual": { "type": ["object", "null"], "properties": { "daily": { "$ref": "#/components/schemas/ManualPeriod" }, "weekly": { "$ref": "#/components/schemas/ManualPeriod" } } }, "states": { "type": "object", "required": ["daily", "weekly"], "properties": { "daily": { "type": "string", "enum": ["missing", "unknown", "current", "stale", "restricted"] }, "weekly": { "type": "string", "enum": ["missing", "unknown", "current", "stale", "restricted"] } } } }, "required": ["records", "manual", "states"] }, "Stage": { "type": "object", "properties": { "title": { "type": "string" }, "startsAt": { "type": ["string", "null"], "format": "date-time" }, "endsAt": { "type": ["string", "null"], "format": "date-time" } }, "required": ["title"] }, "Announcement": { "type": "object", "properties": { "id": { "type": "string" }, "server": { "enum": ["live", "test"] }, "title": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" }, "body": { "type": "string" }, "sourceUrl": { "type": "string", "format": "uri" } }, "required": ["id", "server", "title", "publishedAt", "body"] }, "Activity": { "type": "object", "properties": { "id": { "type": "string" }, "server": { "enum": ["live", "test"] }, "title": { "type": "string" }, "summary": { "type": "string" }, "startsAt": { "type": ["string", "null"], "format": "date-time" }, "endsAt": { "type": ["string", "null"], "format": "date-time" }, "exchangeEndsAt": { "type": ["string", "null"], "format": "date-time" }, "announcementIds": { "type": "array", "items": { "type": "string" } }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/Stage" } } }, "required": ["id", "server", "title", "announcementIds"] }, "Manifest": { "type": "object", "properties": { "schemaVersion": { "const": 1 }, "version": { "type": "string" }, "sha256": { "type": "string" }, "bytes": { "type": "integer" }, "publishedAt": { "type": "string", "format": "date-time" }, "path": { "type": "string" } }, "required": [ "schemaVersion", "version", "sha256", "bytes", "publishedAt", "path" ] }, "Packet": { "type": "object", "properties": { "schemaVersion": { "const": 1 }, "version": { "type": "string" }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } }, "announcements": { "type": "array", "items": { "$ref": "#/components/schemas/Announcement" } } }, "required": ["schemaVersion", "version", "activities", "announcements"] }, "GuildMember": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dutyCode": { "type": "number" }, "dutyLabel": { "type": "string" }, "level": { "type": "number" }, "joinedAt": { "type": "number" }, "joinedDate": { "type": "string" }, "weeklyHonor": { "type": "number" }, "weeklyFeats": { "type": "number" }, "lastWeeklyFeats": { "type": ["number", "null"] }, "totalFeats": { "type": "number" }, "historyDonate": { "type": "number" }, "offlineAt": { "type": "number" }, "offlineAtLabel": { "type": "string" }, "pvpScore": { "type": "number" }, "taskDayFinished": { "type": ["number", "null"] }, "taskWeekFinished": { "type": ["number", "null"] } } }, "Guild": { "type": ["object", "null"], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "level": { "type": "number" }, "funds": { "type": "number" }, "activeMemberCount": { "type": "number" }, "memberCount": { "type": "number" }, "serverId": { "type": "number" }, "createTime": { "type": "number" }, "createDate": { "type": "string" }, "badge": { "type": "number" }, "pvpScore": { "type": "number" }, "leaderName": { "type": "string" }, "declare": { "type": "string" }, "activeRank": { "type": "number" }, "pvpRank": { "type": "number" }, "activeScore": { "type": "number" }, "construction": { "type": "number" }, "insigniaCount": { "type": "number" }, "pvpSeason": { "type": "number" }, "maxGveDifficulty": { "type": "number" }, "creviceDifficulty": { "type": "number" }, "creviceDefeatedDifficulty": { "type": "number" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/GuildMember" } } } }, "ProfileSummary": { "type": "object", "properties": { "file_name": { "type": ["string", "null"] }, "source_kind": { "type": ["string", "null"] }, "completeness": { "type": ["string", "null"] }, "imported_at": { "type": ["string", "null"] }, "guild_name": { "type": ["string", "null"] }, "account_name": { "type": ["string", "null"] }, "server_name": { "type": ["string", "null"] }, "short_id": { "type": ["string", "null"] }, "platform": { "type": ["string", "null"] }, "soul_count": { "type": "integer" }, "shikigami_count": { "type": "integer" }, "item_count": { "type": "integer" }, "realm_card_count": { "type": "integer" }, "guild_member_count": { "type": "integer" }, "exists": { "type": "boolean" } } } } } }