labthings / labthings/python-labthings
Action schema defines links inconsistently with Thing Description
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 19
- 派生
- 2
- PR 合并指标
- 30 天内没有已合并 PR
描述
Thing Description defines the links property of a Thing to be an array of objects, each with "rel" and "href" properties (among others). Would it make sense for Actions to follow suit? This isn't a normative part of the spec, but it would feel quite sensible. It would mean changing from:
{
"status": "completed",
"output": true,
"links": {
"self": {
"href": "https://my_host/actions/id"
}
}
}
to
{
"status": "completed",
"output": true,
"links": [
{"rel": "self", "href":"https://my_host/actions/id"},
]
}
The resulting object is slightly less convenient (I can't just do action["links"]["self"]["href"]) but it is more in keeping with the standard.
This is really a decision for LabThings-FastAPI, but I'm keen not to break compatibility if there was a good reason for doing it the current way.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先审查当前的 Action 响应 schema 和 Thing Description 对 links 的定义,然后追踪现有 Action 响应的任何兼容性预期。当项目决定是否应对齐这些表示形式,并且由此产生的行为、文档和测试反映该决定时,此项工作即完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- flask, python
- 领域
- api, backend
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100