CenterForDigitalHumanities / CenterForDigitalHumanities/rerum_server_nodejs

Import as its Own Endpoint

Offen
#129 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement OSS
Vorherrschende Sprache
JavaScript
Sterne
3
Forks
6
Ø Merge
2 T. 47 Min.
Gemergte PRs (30 T.)
4

Beschreibung

There may be some small advantage to offering an `/import` endpoint when someone explicitly intends to use it instead of having to `/update`. This would require it's own RESTful checks and responses.

An `/import` is a perfect mix of `/create` and `/update`. It "updates an item in the graph" by "creating a new root" in RERUM which references the origin URI through __rerum.history.previous.

I think this endpoint would be a POST request which responds 201 on success. Currently, it is behind PUT `/update` and responds 200 upon success. Something to think about if we decide to do this.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit dem Vergleich des bestehenden Verhaltens der Endpunkte /create und PUT /update. Ermittle die erforderlichen REST-Prüfungen und Antworten für einen POST /import, der eine neue Root erstellt, die über __rerum.history.previous auf die Origin-URI verweist. Als erledigt gilt die Aufgabe, wenn das Verhalten des Endpunkts, einschließlich einer erfolgreichen 201-Antwort, definiert und konsistent implementiert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
api, backend
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.