API responses are getting muddy
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 20/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- javascript
- 领域
- api
调研方向
该 issue 未指定文件、入口点或测试。首先定位 API 请求处理程序和响应构造代码，然后记录现有的响应形状和向后兼容性要求；完成意味着已经就涵盖所提议形式的响应选择设计达成一致。
由索引模型根据 Issue 内容生成。
描述
We need to consider better requests to offer the cleaner responses. We've made some compromises for backward compatibility but not in a generic way. It may be good to find that way. One option would be something like ?responseContainer=new_obj on the request so that we can default to returning the updated document or an array of them or put them inside { queryResults: [ results ] } if the consuming application needs/prefers them that way.
This would mean we would only have to modify old requests to add the parameter and we would be accommodating future requests like metadata if someone wants back the original query, count of results, time to find, most recent, ordering, etc.
- 主要语言
- JavaScript
- 星标
- 3
- 派生
- 7
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
CenterForDigitalHumanities/rerum_server_nodejs 的其他 Issue
-
bug documentation
难度 2/5 1-3 小时 新手友好度 88/100
-
backend dependencies easy
难度 2/5 1-3 小时 新手友好度 84/100
-
难度 2/5 1-3 小时 新手友好度 82/100
CenterForDigitalHumanities/rerum_server_nodejs#290 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 50/100
-
难度 3/5 1-2 天 新手友好度 74/100
查看 CenterForDigitalHumanities/rerum_server_nodejs 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
approved check:passed logos:add
难度 1/5 1 小时以内 新手友好度 74/100
维护者通常 2 天内回复
-
binding:python bug
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
AOSSIE-Org/BabyNest#310 · 1 条评论 ·
维护者通常 1 天内回复
-
bug needs-triage potential-regression
难度 2/5 1-3 小时 新手友好度 78/100
aws/aws-sdk-js-v3#8408 ·
维护者通常 1 天内回复