labthings / labthings/python-labthings
Action schema defines links inconsistently with Thing Description
まだ誰も着手していません。
- 主要言語
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず現在の Action response schema と Thing Description における links の定義を確認し、既存の Action responses に対する互換性の期待事項を追跡します。プロジェクトが表現を整合させるべきかどうかを決定し、その結果生じる動作、ドキュメント、テストがその決定を反映した時点で完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- flask, python
- 領域
- api, backend
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100