wangdl/api-server
2
0
Fork 0
Code Issues 29 Pull Requests Actions Packages Projects Releases Wiki Activity

API-INFO-028 P1 | 学习信息收集 API 文档 【status:todo】 #123

New Issue
Closed
opened 2026-06-07 11:03:41 +08:00 by wangdl · 2 comments
wangdl commented 2026-06-07 11:03:41 +08:00
Owner
Copy Link

目标

编写 docs/learning-info-api.md

内容

总设计、readingTargetType、上传协议、ReadingPosition JSON、activeSecondsDelta 语义、
错误码、批量上报、进度查询、继续学习、summary、trend、heatmap、学习历史、
幂等去重、时区规则、完整示例

格式与 docs/chat-scope-api-contract.md 一致。

## 目标 编写 docs/learning-info-api.md ### 内容 总设计、readingTargetType、上传协议、ReadingPosition JSON、activeSecondsDelta 语义、 错误码、批量上报、进度查询、继续学习、summary、trend、heatmap、学习历史、 幂等去重、时区规则、完整示例 格式与 docs/chat-scope-api-contract.md 一致。
wangdl added this to the M8：学习信息收集与基础分析闭环 milestone 2026-06-07 11:03:41 +08:00
wangdl changed title from API-INFO-018 P1 | 学习信息收集 API 文档 to API-INFO-028 P1 | 学习信息收集 API 文档 2026-06-07 11:22:20 +08:00
wangdl changed title from API-INFO-028 P1 | 学习信息收集 API 文档 to API-INFO-028 P1 | 学习信息收集 API 文档 【status:todo】 2026-06-07 19:04:21 +08:00
wangdl commented 2026-06-07 19:04:22 +08:00
Author
Owner
Copy Link

审查结论：当前 API 项目学习信息收集体系基本为全新建设。可复用：JWT Guard、LearningSession 基础表/CRUD、DailyLearningActivity 基础表、ActivityController 部分接口、LearningRecord schema。其余 ReadingEvent/TemporaryMaterial/Progress/批量上报/Processor/聚合/查询接口/错误码/去重/权限/测试/文档均不存在或仅部分存在。

本 Issue: 文档不存在。

标签: audit:reviewed audit:api-info status:todo work:docs

## 审查结论：当前 API 项目学习信息收集体系基本为全新建设。可复用：JWT Guard、LearningSession 基础表/CRUD、DailyLearningActivity 基础表、ActivityController 部分接口、LearningRecord schema。其余 ReadingEvent/TemporaryMaterial/Progress/批量上报/Processor/聚合/查询接口/错误码/去重/权限/测试/文档均不存在或仅部分存在。 **本 Issue**: 文档不存在。 **标签**: audit:reviewed audit:api-info status:todo work:docs
wangdl commented 2026-06-08 21:06:21 +08:00
Author
Owner
Copy Link

完成报告

交付

docs/learning-info-api.md — 学习信息收集 API 文档，包含：

  • 9 个端点完整定义：请求/响应 shape、参数、错误码
  • readingTargetType 说明 + 权限校验链
  • activeSecondsDelta 语义（增量 vs 累计）
  • 错误码表（14 种）
  • ReadingPosition JSON 格式
  • 幂等去重规则
  • 时区处理规则
  • 完整请求/响应示例

格式：与 docs/chat-scope-api-contract.md 一致

## 完成报告 ### 交付 `docs/learning-info-api.md` — 学习信息收集 API 文档，包含： - **9 个端点**完整定义：请求/响应 shape、参数、错误码 - readingTargetType 说明 + 权限校验链 - activeSecondsDelta 语义（增量 vs 累计） - 错误码表（14 种） - ReadingPosition JSON 格式 - 幂等去重规则 - 时区处理规则 - 完整请求/响应示例 **格式**：与 `docs/chat-scope-api-contract.md` 一致
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area:activity
活动/统计
area:admin
管理后台
area:admin-api
area:ai
AI/RAG
area:ai-runtime
AI Runtime / AI 分析体系相关
area:analytics
area:api
API 接口
area:auth
认证与授权
area:cos
对象存储
area:database
数据库/Migration
area:import
文件导入/解析
area:knowledge
知识库/知识点
area:learning-info
area:learning-session
area:quiz
测验/自测
area:reading-event
area:reading-progress
area:review
复习系统
area:security
安全相关
audit:api-admin-info
audit:api-info
audit:planned
已完成宏观规划，尚未代码审查
audit:reviewed
blocked-by:api-info-aggregation
blocked-by:api-info-core
blocked-by:api-info-ops
blocked-by:api-info-schema
blocked-by:processor
blocked-by:schema
priority:p0
最高优先级，阻塞发布
priority:p1
高优先级，里程碑必需
priority:p2
中优先级，后续版本
repo:api
API 仓库 Issue
status:blocked
被阻塞
status:done
已完成
status:partial
status:todo
type:aggregation
type:bug
缺陷修复
type:design
设计
type:docs
文档
type:feature
新功能
type:migration
type:refactor
重构
type:test
work:admin-api
work:aggregation
work:api
work:artifact
题目/卡片产物
work:audit
work:circuit-breaker
熔断
work:contract
work:design
架构/协议设计工作
work:docs
work:export
work:extend-existing
work:internal-api
Runtime 内部接口
work:job
Job 调度相关
work:new-module
work:new-table
work:ops
work:query
work:quota
额度/限流
work:schema
Prisma Schema 设计
work:security
work:service
Service 层实现
work:snapshot
Snapshot 构建
work:test
No Label
Milestone
No items
No Milestone M8：学习信息收集与基础分析闭环
Projects
Clear projects
No project
Assignees
Clear assignees
suyun-Claude wangdl
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: wangdl/api-server#123
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?