API for Notes
Created by: heapsdigital
Is anyone working on API endpoint for Notes? I don't know if it should be genericised for 'all' noteable types, but for my purposes it would be quite useful in context of an Issue. Unless there is precedent elsewhere an endpoint for each noteable type makes sense (the API can be more abstracted from the underlying gitlab data structure)
e.g. in context of Issues
- list notes: GET /projects/:id/issues/:issue_id/notes
- single note: GET /projects/:id/issues/:issue_id/notes/:note_id
- new note: POST /projects/:id/issues/:issue_id/notes
- delete note: DELETE GET /projects/:id/issues/:issue_id/notes/:note_id
Great work on the API too! I'm using it to integrate stories from Pivotal Tracker, migrate old bugs from Mantis, and also create issues from a mail address.
Activity
Created by: sroth80021
possibly related: Issue 1312 (web hook for notes) -- https://github.com/gitlabhq/gitlabhq/issues/1312
By Administrator on 2012-08-31T05:40:34 (imported from GitLab)
Created by: sjz
Note ids appear to be unique within the project, So instead of:
GET /projects/:id/issues/:issue_id/notes/:note_id`maybe it could be:
GET /projects/:id/notes/:note_idthen if you really wanted to list all notes for a project
GET /projects/:id/notesEither way, it would be a cool feature to have :) Especially as it would enable us to create messages in a custom rolled auto-close system given the current lack of one (#302 (closed))
By Administrator on 2012-09-04T03:58:31 (imported from GitLab)
Created by: heapsdigital
Sure, makes sense.
Pro: That sits better with designing it to accept all noteable types. e.g. the post request could accept noteable_id and noteable_type params (in the db, notes.noteable_id can be an issue_id, a commit hash, merge_request_id, or possibly other noteable_type identifier)
Con: Solution is more intertwined with underlying data, which is fine, less the schema changes :-)
By Administrator on 2012-09-04T21:01:27 (imported from GitLab)
Created by: riyad
The notes carry some context which needs to be set/duplicated (notable_type, notable_id, line_code, etc.) for each following note. To simplify this and to relieve API users of the burden to stay on top of this at all times. I'd also propose to have something like a
POST .../notes/:id/replyend point, that would carry over the meta data mentioned above and only expect "visible" data (e.g. author, content) to be delivered in the request. Does this make sense?By Administrator on 2012-09-16T14:02:07 (imported from GitLab)
Created by: jozefvaclavik
Any progress with this? I'm working on iOS app, and this is kind of bummer for me, that you can't comment/browse whats happening with the issue.
I would also suggest that when you do GET /projects/:id/issues/:id_issue (to return ONE issue), it could straight return all notes within issue. In my opinion, the access point to notes should not be only GET /project/:id/notes(/:id), but as well through endpoint to what notes are related.
I could look more into it. I'm just asking if anyone is already working on it, and whats the progress.
By Administrator on 2012-10-10T17:23:47 (imported from GitLab)
Created by: riyad
@narkoz, @randx is anyone working on the notes API already?
By Administrator on 2012-10-10T16:56:00 (imported from GitLab)
Created by: pdeschen
Just to favour in @jozefvaclavik comments, note api (with some way to link with issues) would give us the ability to import bug comments from one tracking tool into gitlab issue system. Otherwise we'll be missing lots of precious details.
I'm planning on working on a bugzilla importer.
By Administrator on 2012-10-12T22:05:09 (imported from GitLab)
Created by: siuying
+1.
To create mobile gitlab client for issue tracking (much like github issues ), api to view and add notes is needed.
By Administrator on 2012-10-23T15:20:06 (imported from GitLab)
Created by: williscool
+1
then I could update the closes git hook https://github.com/gitlabhq/gitlab-public-wiki/wiki/Hooks
to also add comments to issues with the closing commit
By Administrator on 2012-10-27T20:35:51 (imported from GitLab)
Created by: NARKOZ
Closing since #2123 was merged. More is coming in future.
docs: https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/notes.md
By Administrator on 2012-11-29T22:08:48 (imported from GitLab)
