Action schema defines links inconsistently with Thing Description

Offen

#324 erstellt am 10.8.2023 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: flask, python
Bereich: api, backend

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.

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"
    }
  }
}

{
  "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.

Vorherrschende Sprache: Python
Sterne: 19
Forks: 2
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus labthings/python-labthings

Updating dependencies... Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100

labthings/python-labthings#323 · 3 Kommentare · Erstellt am 15.3.2023
Off-topic: OpenAPI/Swagger Compiler for Server Stubs (ESP32) ? Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 15/100

labthings/python-labthings#302 · 2 Kommentare · Erstellt am 06.12.2021
Changing `ActionView._deque.maxlen` in subclasses Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100

labthings/python-labthings#300 · Erstellt am 26.11.2021
revisiting decorators for actions/properties/etc. Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

labthings/python-labthings#237 · 3 Kommentare · Erstellt am 30.6.2021
Ability to add additional @context members to TD Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

labthings/python-labthings#97 · Erstellt am 04.6.2020

Alle Issues in labthings/python-labthings