Make it easier to document a resource with fields and links that come and go as the resource's state changes
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- java
调研方向
No files, tests, or entry points are named. Start by tracing how documentation is accumulated and snippets are produced across service calls. Done means documented links and fields can be collected over multiple calls and verified against the resource's observed states without relying on optional markers.
由索引模型根据 Issue 内容生成。
描述
At the moment you can document a link or field that isn't there by marking it as optional. It works, but it can lead to inaccuracies in the documentation. An alternative would be to allow the links, fields etc that need to be documented to be accumulated over multiple calls to the service. Once all of the calls are complete, and the resource has transitioned through its various states, the snippet can be produced and it can verify that all of the documented links, fields, etc were actually present.
- 主要语言
- Java
- 星标
- 1.2k
- 派生
- 733
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
spring-projects/spring-restdocs 的其他 Issue
-
status: waiting-for-triage
难度 4/5 3-5 天 新手友好度 35/100
spring-projects/spring-restdocs#1075 ·
-
Support extracting Bean Validation constraints from method parameters可能重新可做 关联的 PR 已关闭且未合并。 未关闭status: waiting-for-triage
难度 5/5 一周以上 新手友好度 45/100
spring-projects/spring-restdocs#1026 · 2 条评论 ·
-
status: blocked status: waiting-for-triage
难度 4/5 3-5 天 新手友好度 35/100
spring-projects/spring-restdocs#953 · 7 条评论 ·
-
Add support for modifying a URI's path during pre-processing可能重新可做 关联的 PR 已关闭且未合并。 未关闭type: enhancement
难度 3/5 1-2 天 新手友好度 45/100
-
status: feedback-provided status: waiting-for-triage
难度 3/5 1-2 天 新手友好度 45/100
spring-projects/spring-restdocs#937 · 4 条评论 ·
查看 spring-projects/spring-restdocs 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
federicoiosue/Omni-Notes#1032 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
unitycatalog/unitycatalog#2025 ·
维护者通常 4 天内回复
-
难度 1/5 1-3 小时 新手友好度 78/100
krizaka/krizaka-notifications#22 ·
维护者通常 1 天内回复
-
CommandDispatcher.register returns a node that is not in the tree when the literal is already registered可能已有人在做 @auraseb 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 83/100
-
ToolCallbackProvider AutoConfiguration does not preserve tool order可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭status: waiting-for-triage
难度 2/5 1-3 小时 新手友好度 79/100
spring-projects/spring-ai#7206 ·
维护者通常 2 天内回复