Action schema defines links inconsistently with Thing Description
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start by reviewing the current Action response schema and the Thing Description definition of links, then trace any compatibility expectations for existing action responses. This is done when the project has decided whether the representations should be aligned and the resulting behavior, documentation, and tests reflect that decision.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Python
- Stars
- 19
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from labthings/python-labthings
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
labthings/python-labthings#323 · 3 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
labthings/python-labthings#302 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
labthings/python-labthings#300 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
labthings/python-labthings#237 · 3 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
All issues in labthings/python-labthings
Similar issues
-
bug priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
CyberAgent/psd2svg#436 ·
-
area/install-update comp/cli comp/desktop P3 sweeper:risk-compatibility type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
NousResearch/hermes-agent#122386 · 1 comment ·
-
ai-generated
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vllm-project/production-stack#1105 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100