labthings / labthings/python-labthings
Action schema defines links inconsistently with Thing Description
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 19
- Forks
- 2
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, das aktuelle Action-Antwortschema und die Thing Description-Definition von links zu überprüfen, und verfolge anschließend alle Kompatibilitätserwartungen für bestehende Action-Antworten. Dies ist abgeschlossen, wenn das Projekt entschieden hat, ob die Repräsentationen angeglichen werden sollen, und das daraus resultierende Verhalten, die Dokumentation und die Tests diese Entscheidung widerspiegeln.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- flask, python
- Bereich
- api, backend
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100