Talk:stoney core: REST API

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 Wikipedia --Tiziano (talk) 12:37, 5 January 2015 (CET)
      • ACK --Chrigu (talk) 16:18, 8 January 2015 (CET)

• 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. --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. --Chrigu (talk) 16:18, 8 January 2015 (CET)

• 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 --Tiziano (talk) 12:37, 5 January 2015 (CET)

• 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 --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?

• Mit belongsToResellerId und belongsToCustomerId sind wir inkonsequent. Manchmal haben wir eine belongsToResellerId, manchmal nicht.

• Relations (queries/scoping): Haben wir nicht getestet!
  • /v1/resellers/4000001/customers -> collection resource (all customers of reseller with uid=4000001)
  • /v1/resellers/4000001/customers/4000002 -> resource (the customer with uid=4000002 of reseller with uid=4000001)
  • /v1/customers?belongsToResellerUID=4000001 -> collection resource (all customers of reseller with uid=4000001)
  • /v1/customers/4000002 -> resource (the customer with uid=4000002 of reseller with uid=4000001)

• Wollen wir zukünftig statt zuwenig Berechtigungen immer einen leeren JSON Wert zurück geben? Ähnlich wie bei der Suche, wenn sie keine Ergebnisse findet.
  • Sonst konkret definieren, was zurück kommen muss.
  • Bei einer Collection: ja. (tun wir das nicht bereits?). Bei einem Element muss ein Fehlerwert zurückgegeben werden. Ich hätte hier gerne jedoch 404 Not Found anstatt Permission Denied. --Tiziano (talk) 12:37, 5 January 2015 (CET)
  • Das ist bereits definiert 403 (Forbidden) mit einem JSON error object welches weitere Details liefert. --Chrigu (talk) 16:10, 8 January 2015 (CET)

• 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 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. --Tiziano (talk) 12:37, 5 January 2015 (CET)
  • Müssten wir nicht auch noch unterschiedliche Response Header zurückgeben? Wenn kein Body, benötige ich auch den Content-Header nicht ... Oder geht das zu weit?

• Actions
  • Den neuen HTTP Status Code "202 Accepted" einführen?
    • The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place.
    • Eine Location für die Status-Abfrage ist nötig! In Form einer Job-ID oder ähnlichem.
    • Ja, aber dafür benötigen wir das Framework dahinter. Im Moment würde ich das ignorieren und so tun als wäre die Aktion sofort und erfolgreich ausgeführt worden. --Tiziano (talk) 12:37, 5 January 2015 (CET)
      • die Alternative dazu ist dass wir uns bald für eine Messaging Middleware Lösung für Puppet/MCollective entscheiden und darauf aufbauend einen Job Server hochbringen. Das hiesse vermutlich: RabbitMQ/RabbitMQ Symfony Bundle und Celery --Tiziano (talk) 18:03, 7 January 2015 (CET)

• Passwörter
  • Bei Update (PUT) haben wir nirgendwo klar definiert, dass das Passwort nicht nötig ist.
  • Es ist nirgendwo definiert, wie ein Passwort aussehen darf:
    • Minimale Länge?
    • Gross-/Kleinschreibung?
    • Sonderzeichen und/oder Zahlen?
  • Fände es gut, wenn wir dies zentral vorgeben.
    • Wir können minimale Vorgaben dokumentieren, hängt aber ggf vom Authentication Backend ab. Allzuviel Zeit würde hier nicht investieren. --Tiziano (talk) 12:37, 5 January 2015 (CET)
  • Eventuell lassen wir die Vorgaben via API abfragen? In diesem Falle müsste es ins stoney-core Modul gehören?
    • Zu aufwändig für den Nutzen. --Tiziano (talk) 12:37, 5 January 2015 (CET)