Class Issue

A project issue. See http://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md

Nested Classes

[hide private]

Note
An issue note.

Instance Methods

[hide private]

save()
Update GitLab with changes to this Issue

close(state_event)
Close this issue.

reopen(state_event)
Reopen this previously closed issue.

notes(limit=None, page=None, per_page=None)
Return a list of Issue notes.

find_note(find_all=False, cached=None, **kwargs)
Find the first matching Note whose properties match all of the key, value pairs given in the arguments.

note(id)
Return the Note specified by the given id.

add_note(body)
Add a new note to this Issue

Method Details

[hide private]

close(state_event)

Close this issue. This is not idempotent in GitLab.

reopen(state_event)

Reopen this previously closed issue. This is not idempotent in GitLab.

notes(limit=None, page=None, per_page=None)

Return a list of Issue notes.

limit can be given to specify the maximum list size.

page and per_page can be used for pagination.

limit should not be specified with either page or per_page. If it is, limit takes precedence.

find_note(find_all=False, cached=None, **kwargs)

Find the first matching Note whose properties match all of the key, value pairs given in the arguments.

If find_all is true, a list of all matching notes will be returned. If a cached list is not given, the list to search will be queried from the server each time this is called.

Searching is done via an unoptimized, inefficient o(n) search.

All arguments must be named.

note(id)

Return the Note specified by the given id. get_note() may be used as an alias for this function.

add_note(body)

Add a new note to this Issue

On success, the newly created object is returned.