module Gitlab::Client::Note

Overview

Defines methods related to note.

Notes are comments on snippets, issues or merge requests..

See http://docs.gitlab.com/ce/api/notes.html

Direct including types

Defined in:

gitlab/client/note.cr

Instance Method Summary

Instance Method Detail

def create_issue_note(project_id : Int32, issue_id : Int32, body : String, created_at : String | Nil = nil) : JSON::Any #

Create note of issue in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] issue_id The ID of an issue.
  • param [String] body The body of a note.
  • params [String] created_at Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z.
  • return [JSON::Any] Information about the created note of issue in a project.
client.create_issue_note(1, 10, "great work!")
client.create_issue_note(1, 12, "great work!", "2016-03-11T03:45:40Z")

[View source]
def create_merge_request_note(project_id : Int32, merge_request_id : Int32, body : String, created_at : String | Nil = nil) : JSON::Any #

Create note of merge request in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] merge_request_id The ID of a merge request.
  • param [String] body The title of an merge_requests.
  • return [JSON::Any] Information about the created note of merge request in a project.
client.create_merge_request_note(1, 10, "great work!")

[View source]
def create_snippet_note(project_id : Int32, snippet_id : Int32, body : String) : JSON::Any #

Create note of snippet in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] snippet_id The ID of an snippet.
  • param [String] body The body of an snippet.
  • return [JSON::Any] Information about the created note of snippet in a project.
client.create_snippet_note(1, 10, "great work!")

[View source]
def delete_issue_note(project_id : Int32, issue_id : Int32, note_id : Int32) : JSON::Any | Bool #

Deiete a note of issue in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] issue_id The ID of an issue.
  • param [Int32] note_id The ID of a note.
  • return [JSON::Any] Information about the deleted note of issue.
client.delete_issue_note(1, 3, 6)

[View source]
def delete_merge_request_note(project_id : Int32, merge_request_id : Int32, note_id : Int32) : JSON::Any | Bool #

Deiete a note of merge request in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] merge_request_id The ID of a merge request.
  • param [Int32] note_id The ID of a note.
  • return [JSON::Any] Information about the deleted note of merge request.
client.delete_merge_request_note(1, 3, 6)

[View source]
def delete_snippet_note(project_id : Int32, snippet_id : Int32, note_id : Int32) : JSON::Any | Bool #

Deiete a note of snippet in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] snippet_id The ID of an snippet.
  • param [Int32] note_id The ID of a note.
  • return [JSON::Any] Information about the deleted note of snippet.
client.delete_snippet_note(1, 3, 6)

[View source]
def edit_issue_note(project_id : Int32, issue_id : Int32, note_id : Int32, body : String) : JSON::Any #

Edit a note of issue in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] issue_id The ID of an issue.
  • param [Int32] note_id The ID of a note.
  • param [String] body The body of a note.
  • return [JSON::Any] Information about the updated issue in a project.
client.edit_issue_note(1, 10, 22, "great work!")

[View source]
def edit_merge_request_note(project_id : Int32, merge_requests_id : Int32, note_id : Int32, body : String) : JSON::Any #

Edit a note of merge request in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] merge_request_id The ID of an merge request.
  • param [Int32] note_id The ID of a note.
  • param [String] body The title of a merge request.
  • return [JSON::Any] Information about the updated merge request in a project.
client.edit_merge_request_note(1, 10, 22, "great work!")

[View source]
def edit_snippet_note(project_id : Int32, snippet_id : Int32, note_id : Int32, body : String) : JSON::Any #

Edit a note of snippet in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] snippet_id The ID of an snippet.
  • param [Int32] note_id The ID of a note.
  • param [String] body The body of an snippet.
  • return [JSON::Any] Information about the updated snippet in a project.
client.edit_snippet_note(1, 10, 22, "great work!")

[View source]
def issue_note(project_id : Int32, issue_id : Int32, note_id : Int32) : JSON::Any #

Get single note of issue in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] issue_id The ID of an issue.
  • param [Int32] note_id The ID of a note.
  • return [JSON::Any] Information about the note of issue.
client.issue_note(1, 10)

[View source]
def issue_notes(project_id : Int32, issue_id : Int32, params : Hash | Nil = nil) : JSON::Any #

Gets a list notes of issue in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] issue_id The ID of an issue.
  • param [Hash] params A customizable set of params.
  • option params [String] :page The page number.
  • option params [String] :per_page The number of results per page. default is 20
  • return [JSON::Any] List of notes of issue under a project.
client.issue_notes(1, 1)
client.issue_notes(1, 5, {"per_page" => "10"})

[View source]
def merge_request_note(project_id : Int32, merge_request_id : Int32, note_id : Int32) : JSON::Any #

Get single note of merge request in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] merge_request_id The ID of a merge request.
  • param [Int32] note_id The ID of a note.
  • return [JSON::Any] Information about the note of merge request.
client.merge_request_note(1, 10)

[View source]
def merge_request_notes(project_id : Int32, merge_request_id : Int32, params : Hash | Nil = nil) : JSON::Any #

Gets a list notes of merge request in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] merge_request_id The ID of a merge request.
  • param [Hash] params A customizable set of params.
  • option params [String] :page The page number.
  • option params [String] :per_page The number of results per page. default is 20
  • return [JSON::Any] List of notes of merge request under a project.
client.merge_request_notes(1, 1)
client.merge_request_notes(1, 5, {"per_page" => "10"})

[View source]
def snippet_note(project_id : Int32, snippet_id : Int32, note_id : Int32) : JSON::Any #

Get single note of snippet in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] snippet_id The ID of an snippet.
  • param [Int32] note_id The ID of a note.
  • return [JSON::Any] Information about the note of snippet.
client.snippet_note(1, 10)

[View source]
def snippet_notes(project_id : Int32, snippet_id : Int32, params : Hash | Nil = nil) : JSON::Any #

Gets a list notes of snippet in a project.

  • param [Int32] project_id The ID of a project.
  • param [Int32] snippet_id The ID of an snippet.
  • param [Hash] params A customizable set of params.
  • option params [String] :page The page number.
  • option params [String] :per_page The number of results per page. default is 20
  • return [JSON::Any] List of notes of snippet under a project.
client.snippet_notes(1, 1)
client.snippet_notes(1, 5, {"per_page" => "10"})

[View source]