mirror of
https://github.com/wahyd4/gitlabhq.git
synced 2026-08-10 21:26:07 +10:00
Dmitriy ZaporozhetsandRobert Speicher
48e86ec610
Award Emoji This it first iteration of award emoji feature. We have plan to extend emoji picker by the next release. For now, you can add award by clicking to the emoji picker or posting a regular comment with emoji like "👍" and any other. You can post not only emoji that listed in the emoji picker. See merge request !1825
5.0 KiB
5.0 KiB
Notes
Notes are comments on snippets, issues or merge requests.
Issues
List project issue notes
Gets a list of all notes for a single issue.
GET /projects/:id/issues/:issue_id/notes
Parameters:
id(required) - The ID of a projectissue_id(required) - The ID of an issue
[
{
"id": 302,
"body": "Status changed to closed",
"attachment": null,
"author": {
"id": 1,
"username": "pipin",
"email": "admin@example.com",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:22:45Z",
"system": true
},
{
"id": 305,
"body": "Text of the comment\r\n",
"attachment": null,
"author": {
"id": 1,
"username": "pipin",
"email": "admin@example.com",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:56:03Z",
"system": false
}
]
Get single issue note
Returns a single note for a specific project issue
GET /projects/:id/issues/:issue_id/notes/:note_id
Parameters:
id(required) - The ID of a projectissue_id(required) - The ID of a project issuenote_id(required) - The ID of an issue note
Create new issue note
Creates a new note to a single project issue.
POST /projects/:id/issues/:issue_id/notes
Parameters:
id(required) - The ID of a projectissue_id(required) - The ID of an issuebody(required) - The content of a note
Modify existing issue note
Modify existing note of an issue.
PUT /projects/:id/issues/:issue_id/notes/:note_id
Parameters:
id(required) - The ID of a projectissue_id(required) - The ID of an issuenote_id(required) - The ID of a notebody(required) - The content of a note
Snippets
List all snippet notes
Gets a list of all notes for a single snippet. Snippet notes are comments users can post to a snippet.
GET /projects/:id/snippets/:snippet_id/notes
Parameters:
id(required) - The ID of a projectsnippet_id(required) - The ID of a project snippet
Get single snippet note
Returns a single note for a given snippet.
GET /projects/:id/snippets/:snippet_id/notes/:note_id
Parameters:
id(required) - The ID of a projectsnippet_id(required) - The ID of a project snippetnote_id(required) - The ID of an snippet note
{
"id": 52,
"title": "Snippet",
"file_name": "snippet.rb",
"author": {
"id": 1,
"username": "pipin",
"email": "admin@example.com",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"expires_at": null,
"updated_at": "2013-10-02T07:34:20Z",
"created_at": "2013-10-02T07:34:20Z"
}
Create new snippet note
Creates a new note for a single snippet. Snippet notes are comments users can post to a snippet.
POST /projects/:id/snippets/:snippet_id/notes
Parameters:
id(required) - The ID of a projectsnippet_id(required) - The ID of a snippetbody(required) - The content of a note
Modify existing snippet note
Modify existing note of a snippet.
PUT /projects/:id/snippets/:snippet_id/notes/:note_id
Parameters:
id(required) - The ID of a projectsnippet_id(required) - The ID of a snippetnote_id(required) - The ID of a notebody(required) - The content of a note
Merge Requests
List all merge request notes
Gets a list of all notes for a single merge request.
GET /projects/:id/merge_requests/:merge_request_id/notes
Parameters:
id(required) - The ID of a projectmerge_request_id(required) - The ID of a project merge request
Get single merge request note
Returns a single note for a given merge request.
GET /projects/:id/merge_requests/:merge_request_id/notes/:note_id
Parameters:
id(required) - The ID of a projectmerge_request_id(required) - The ID of a project merge requestnote_id(required) - The ID of a merge request note
{
"id": 301,
"body": "Comment for MR",
"attachment": null,
"author": {
"id": 1,
"username": "pipin",
"email": "admin@example.com",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T08:57:14Z"
}
Create new merge request note
Creates a new note for a single merge request.
POST /projects/:id/merge_requests/:merge_request_id/notes
Parameters:
id(required) - The ID of a projectmerge_request_id(required) - The ID of a merge requestbody(required) - The content of a note
Modify existing merge request note
Modify existing note of a merge request.
PUT /projects/:id/merge_requests/:merge_request_id/notes/:note_id
Parameters:
id(required) - The ID of a projectmerge_request_id(required) - The ID of a merge requestnote_id(required) - The ID of a notebody(required) - The content of a note