Changes

Talk:stoney core: REST API

4,253 bytes removed, 13:56, 11 January 2015
/* Fragen / Inkonsistenzen */
= Fragen / Inkonsistenzen =
 
* Wir haben im Header eine Location. Im Body manchmal ja, manchmal nein.
** Gehört die Location in die Body Response rein? Falls ja:
*** Location müsste bei Update auch nicht hochgeschrieben werden?
*** es kommt drauf an: bei einer Collection/Such-Resultat/Liste sollte bei jedem einzelnen Element eine Location mitgegeben werden unter welchem das (vollständige) Element abgerufen werden kann. Als Teil eines Elements macht es meistens keinen Sinn. Im Header sollte es nur als Antwort vom Server kommen bei einem POST-Request (also beim Erstellen einer neuen Ressource) zusammen mit einem 201, siehe [http://en.wikipedia.org/wiki/HTTP_location Wikipedia] --[[User:Tiziano|Tiziano]] ([[User talk:Tiziano|talk]]) 12:37, 5 January 2015 (CET)
**** ACK --[[User:Chrigu|Chrigu]] ([[User talk:Chrigu|talk]]) 16:18, 8 January 2015 (CET)
** '''Create, collection retrieval, search'''
 
* Update
** Statt leerem Body wäre hier eine Antwort logisch, wie bei der Kreierung.
*** Die Antwort ist gemäss REST mit dem Code 200 bereits gegeben. Vielleicht auch hier 204 verwenden stattdessen. --[[User:Tiziano|Tiziano]] ([[User talk:Tiziano|talk]]) 12:37, 5 January 2015 (CET)
**** Ja, strikt gsehen müsste hier 204 zurückkommen. Inhalt brauch es meinern Meinung nach nicht, beim Update ist ja die Location und Id, im gegensatzt zu Create, bereits bekannt. --[[User:Chrigu|Chrigu]] ([[User talk:Chrigu|talk]]) 16:18, 8 January 2015 (CET)
** '''204 und leerer Body'''
** '''Content-Type: application/json; charset=utf-8''' immer zurückgeben.
 
* http://wiki.stoney-cloud.org/wiki/stoney_core:_People_Resource_-_REST_API#People_collection_retrieval_response_message
** Location ist definiert, jedoch im Example nicht drin und entsprechend auch nicht umgesetzt.
** Location würde in diesem Falle dem "current" entsprechen (zwischen "pre" und "next").
** Gemäss HTTP Protokoll auch nicht vorgesehen. Fehler in der Definition --[[User:Tiziano|Tiziano]] ([[User talk:Tiziano|talk]]) 12:37, 5 January 2015 (CET)
* '''Location aus Spez raus bei Collection'''
 
* Caching Controls: Manchmal kommt "Cache-Control: no-cache" zurück, manchmal "Cache-Control: none, private".
** ich vermute dass hier der Webserver noch was selbst macht --[[User:Tiziano|Tiziano]] ([[User talk:Tiziano|talk]]) 12:37, 5 January 2015 (CET)
* the service must recognize ETag, Last-Modified and Cache-Control: none provided by the client and act accordingly.
** Machen wir überhaupt etwas mit dem "Cache-Control: none"? Müsste dies nicht eh der Default-Wert sein?
** '''Cache-Control auf nicht cachen setzen, wenn nichts anderes angegeben ist'''. -> definieren
** '''Nur Server Kontrolle oder auch Cache-Control vom Client?''' -> Abklären
 
* Mit belongsToResellerId und belongsToCustomerId sind wir inkonsequent. Manchmal haben wir eine belongsToResellerId, manchmal nicht.
** '''Falls es nicht zu Problemen/Inkonsistenz kommt, belongsToResellerId nur zurückgeben, wenn der Benutzer ein Super User ist.'''
* Relations (queries/scoping): Haben wir nicht getestet!
** Das ist bereits definiert [[stoney_core:_REST_API#Error_codes_and_responses|403 (Forbidden) mit einem JSON error object]] welches weitere Details liefert. --[[User:Chrigu|Chrigu]] ([[User talk:Chrigu|talk]]) 16:10, 8 January 2015 (CET)
** '''403 ist OK'''
 
* Meiner Meinung nach müsste gemäss Spezifikation (On success (200) an empty response message body will be returned, otherwise ...) bei einer Löschung ein leerer JSON String und nicht "{ "success": 1 } zurück gegeben werden.
** http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_Success
** Wir müssten eigentlich "204 No Content" erhalten:
*** The server successfully processed the request, but is not returning any content. Usually used as a response to a successful delete request.
** Bei "200 OK" käme sonst "In a POST request the response will contain an entity describing or containing the result of the action." zurück.
*** In diesem Falle würde ich eher "{ "Deletion successful": 1 } erwarten.
** Gemäss [http://stackoverflow.com/questions/2342579/http-status-code-for-update-and-delete Stackoverflow] ist sowohl 200 als 204 ok. Wir haben uns scheinbar für 200 entschieden. Ein Client wird vermutlich nur auf 200/204 prüfen und den Body sowieso ignorieren, von daher egal. Ich persönlich würde 204 nehmen damit wir keinen Text zurückgeben müssen. --[[User:Tiziano|Tiziano]] ([[User talk:Tiziano|talk]]) 12:37, 5 January 2015 (CET)
*** ACK --[[User:Chrigu|Chrigu]] ([[User talk:Chrigu|talk]]) 16:20, 8 January 2015 (CET)
** '''204 No Content ist OK'''
* Actions
SLB, editor, reviewer
3,368
edits