When a payload has fields with mixed presence documenting those fields may still result in a failure due to undocumented fields
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 42/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- java
调研方向
Start by reproducing the JSON payload with the documented paths: count, items[].k1, and items[].k2[].name. Inspect the handling of documented fields and cascading removal of empty objects and arrays, then add coverage showing that both empty and populated items[].k2 entries are handled without an undocumented-field failure.
由索引模型根据 Issue 内容生成。
描述
Taken from this question on Stack Overflow, consider the following JSON payload:
{
"count": 2,
"items": [
{
"k1": "v1",
"k2": []
},
{
"k1": "v2",
"k2": [
{
"name": "joe"
},
{
"name": "alice"
}
]
}
]
}
Documenting the following fields should be sufficient for the payload to be considered fully documented:
countitems[].k1items[].k2[].name
Instead, REST Docs reports that items[].k2 has not been documented.
When items[].k2[].name is documented, it's removed from its containing object. The object then becomes empty and it's removed from its parent array. This parent array, items[].k2 then becomes empty so it is removed from items. This only works for the second items[].k2 entry in the payload. The first items[].k2 entry is unaffected because it's empty to begin with. As a result, there's no removal of the name entry to trigger the cascading removal of empty containers (objects or arrays).
- 主要语言
- 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 小时 新手友好度 78/100
oracle/graalvm-reachability-metadata#11318 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 82/100
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
apache/maven-remote-resources-plugin#335 ·
维护者通常 1 天内回复
-
infrastructure P2 security
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 74/100
logisim-evolution/logisim-evolution#3138 ·
维护者通常 1 天内回复