Aliased Attribute Names Are Not Used In Error Responses
还没有人认领这个 Issue。
评估
调研方向
未指定实现文件或测试。复现委托的 attribute :active, delegate: :status_is_active 情况,并跟踪验证错误的序列化方式;完成标准是错误详情和 JSON:API source pointer 都使用 active 而不是 status_is_active。
由索引模型根据 Issue 内容生成。
描述
This issue is a (choose one):
- [X ] Problem/bug report.
- Feature request.
- Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.
Checklist before submitting:
- [ X] I've searched for an existing issue.
- I've asked my question on Gitter and have not received a satisfactory answer.
- I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
- [ X] The feature I'm asking for is compliant with the JSON:API spec.
Description
I have a model with an attribute named status_is_active. In the API we want this to render as active so do the following in the resource:
attribute :active, delegate: :status_is_active
If there is an API error related to this attribute, the error reports the name from the model rather than the name from the resource. For example:
{
"errors": [
{
"title": "is not included in the list",
"detail": "status_is_active - is not included in the list",
"code": "100",
"source": {
"pointer": "/data/attributes/status_is_active"
},
"status": "422"
}
]
}
Expected: the error uses the name of the attribute in the resource rather than the name used in the model. For example:
{
"errors": [
{
"title": "is not included in the list",
"detail": "active - is not included in the list",
"code": "100",
"source": {
"pointer": "/data/attributes/active"
},
"status": "422"
}
]
}
Rationale: users of the API only know about what's in the API - returning a value from the model that is aliased in the API is confusing/wrong.
Thanks!
- 主要语言
- Ruby
- 星标
- 2.3k
- 派生
- 546
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
JSONAPI-Resources/jsonapi-resources 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 85/100
-
难度 3/5 1-2 天 新手友好度 50/100
JSONAPI-Resources/jsonapi-resources#1488 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 42/100
JSONAPI-Resources/jsonapi-resources#1479 · 2 条评论 ·
-
难度 4/5 3-5 天 新手友好度 30/100
JSONAPI-Resources/jsonapi-resources#1477 · 3 条评论 · 1 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 45/100
查看 JSONAPI-Resources/jsonapi-resources 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
-
bug
难度 1/5 1 小时以内 新手友好度 90/100
riscv/riscv-unified-db#2626 ·
-
Component: GLib
难度 2/5 1-3 小时 新手友好度 70/100
-
ds-drift
难度 2/5 1-3 小时 新手友好度 70/100
we-promise/sure#3693 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
simp/pupmod-simp-simp#395 ·