Module: Gitlab::Client::Notes

Creates a new issue note.

@example

  Gitlab.create_issue_note(6, 1, 'Adding a note to my issue.')

@param [Integer] project The ID of a project. @param [Integer] issue The ID of an issue. @param [String] body The body of a note. @return [Gitlab::ObjectifiedHash] Information about created note.

create_merge_request_note(project, merge_request, body)

Creates a new note for a single merge request.

@example

  Gitlab.create_merge_request_note(5, 3, 'This MR is ready for review.')

@param [Integer] project The ID of a project. @param [Integer] merge_request The ID of a merge request. @param [String] body The content of a note.

create_note(project, body)

Creates a new wall note.

@example

  Gitlab.create_note(5, 'This is a wall note!')

@param [Integer] project The ID of a project. @param [String] body The body of a note. @return [Gitlab::ObjectifiedHash] Information about created note.

create_snippet_note(project, snippet, body)

Creates a new snippet note.

@example

  Gitlab.create_snippet_note(3, 2, 'Look at this awesome snippet!')

@param [Integer] project The ID of a project. @param [Integer] snippet The ID of a snippet. @param [String] body The body of a note. @return [Gitlab::ObjectifiedHash] Information about created note.

issue_note(project, issue, id)

Gets a single issue note.

@example

  Gitlab.issue_note(5, 10, 1)

@param [Integer] project The ID of a project. @param [Integer] issue The ID of an issue. @param [Integer] id The ID of a note. @return [Gitlab::ObjectifiedHash]

issue_notes(project, issue, options={})

Gets a list of notes for a issue.

@example

  Gitlab.issue_notes(5, 10)

@param [Integer] project The ID of a project. @param [Integer] issue The ID of an issue. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

merge_request_note(project, merge_request, id)

Gets a single merge_request note.

@example

  Gitlab.merge_request_note(5, 11, 3)

@param [Integer] project The ID of a project. @param [Integer] merge_request The ID of a merge_request. @param [Integer] id The ID of a note. @return [Gitlab::ObjectifiedHash]

merge_request_notes(project, merge_request, options={})

Gets a list of notes for a merge request.

@example

  Gitlab.merge_request_notes(5, 1)

@param [Integer] project The ID of a project. @param [Integer] merge_request The ID of a merge request. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

note(project, id)

Gets a single wall note.

@example

  Gitlab.note(5, 15)

@param [Integer] project The ID of a project. @param [Integer] id The ID of a note. @return [Gitlab::ObjectifiedHash]

notes(project, options={})

Gets a list of projects notes.

@example

  Gitlab.notes(5)

@param [Integer] project The ID of a project. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

snippet_note(project, snippet, id)

Gets a single snippet note.

@example

  Gitlab.snippet_note(5, 11, 3)

@param [Integer] project The ID of a project. @param [Integer] snippet The ID of a snippet. @param [Integer] id The ID of a note. @return [Gitlab::ObjectifiedHash]

snippet_notes(project, snippet, options={})

Gets a list of notes for a snippet.

@example

  Gitlab.snippet_notes(5, 1)

@param [Integer] project The ID of a project. @param [Integer] snippet The ID of a snippet. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

Methods

Public Instance methods