{"action":"created","issue":{"url":"https://api.github.com/repos/cozy/cozy-stack/issues/7","repository_url":"https://api.github.com/repos/cozy/cozy-stack","labels_url":"https://api.github.com/repos/cozy/cozy-stack/issues/7/labels{/name}","comments_url":"https://api.github.com/repos/cozy/cozy-stack/issues/7/comments","events_url":"https://api.github.com/repos/cozy/cozy-stack/issues/7/events","html_url":"https://github.com/cozy/cozy-stack/pull/7","id":178900382,"number":7,"title":"Add documentation for next sprint CRUD API","user":{"login":"aenario","id":1580287,"avatar_url":"https://avatars.githubusercontent.com/u/1580287?v=3","gravatar_id":"","url":"https://api.github.com/users/aenario","html_url":"https://github.com/aenario","followers_url":"https://api.github.com/users/aenario/followers","following_url":"https://api.github.com/users/aenario/following{/other_user}","gists_url":"https://api.github.com/users/aenario/gists{/gist_id}","starred_url":"https://api.github.com/users/aenario/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aenario/subscriptions","organizations_url":"https://api.github.com/users/aenario/orgs","repos_url":"https://api.github.com/users/aenario/repos","events_url":"https://api.github.com/users/aenario/events{/privacy}","received_events_url":"https://api.github.com/users/aenario/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":7,"created_at":"2016-09-23T15:02:55Z","updated_at":"2016-09-28T15:56:00Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/cozy/cozy-stack/pulls/7","html_url":"https://github.com/cozy/cozy-stack/pull/7","diff_url":"https://github.com/cozy/cozy-stack/pull/7.diff","patch_url":"https://github.com/cozy/cozy-stack/pull/7.patch"},"body":"RFC @nono\r\n\r\nFirst shot at documenting the API for data manipulation.\r\n\r\nBasically just a JSONAPI wrapper to Couchdb\r\n\r\nDecision to be discussed : \r\n- Do we really want JSON-API for these route too or should we consider them lower level.\r\n- The former DS hided `_rev` from the client, I believe this was unwise as we ended up reimplementing it in places for synchronisation with other sources (*dav and imap)\r\n- Should we really allow the creation of a doc with a given `_id` ? The only proper way to use this API is to wrap it in a trycatch and do a `PUT` instead if the doc already exists. It seems we should push devs to always do a `PUT`, or eventually a `PATCH` if only changing some fields.\r\n- keeping the type (formerly `docType`) in the document seems convenient, however, it should be marked as a special field with `_`. \r\n- I added the `type` to the URL, it is not a big effort on developper part but will allow some optimisations later.\r\n- Is the error format lacking something ? One of the issue we had in previous stack was the lack of uniformity and lost of information in error reporting."},"comment":{"url":"https://api.github.com/repos/cozy/cozy-stack/issues/comments/250211057","html_url":"https://github.com/cozy/cozy-stack/pull/7#issuecomment-250211057","issue_url":"https://api.github.com/repos/cozy/cozy-stack/issues/7","id":250211057,"user":{"login":"aenario","id":1580287,"avatar_url":"https://avatars.githubusercontent.com/u/1580287?v=3","gravatar_id":"","url":"https://api.github.com/users/aenario","html_url":"https://github.com/aenario","followers_url":"https://api.github.com/users/aenario/followers","following_url":"https://api.github.com/users/aenario/following{/other_user}","gists_url":"https://api.github.com/users/aenario/gists{/gist_id}","starred_url":"https://api.github.com/users/aenario/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aenario/subscriptions","organizations_url":"https://api.github.com/users/aenario/orgs","repos_url":"https://api.github.com/users/aenario/repos","events_url":"https://api.github.com/users/aenario/events{/privacy}","received_events_url":"https://api.github.com/users/aenario/received_events","type":"User","site_admin":false},"created_at":"2016-09-28T15:56:00Z","updated_at":"2016-09-28T15:56:00Z","body":"Just pushed some changes \r\n\r\n1. Added the delete API, as it fall within this sprint exploration scope\r\n2. Fix the doctype was not fully qualified in creation's OK response.\r\n\r\n\r\nWhile implementing the GET (PR incoming), I am bothered by the fully qualified type identifier containing \"/\" (where do the type stop, and the id start ? I cant just use gin's router, i need to do some parsing by hand). While it's still an option, I think we might want to switch to a java-like format `io.cozy.types.events`\r\n\r\n\r\n\r\n\r\n\r\n\r\n"}}
{"actor":{"display_login":"aenario"}}